Skip to content

Commit

Permalink
feat: simplify docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Kai Hu committed May 19, 2024
1 parent 4c0386e commit 702a627
Showing 1 changed file with 7 additions and 29 deletions.
36 changes: 7 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,42 +12,20 @@ This Python package is automatically generated by the [OpenAPI Generator](https:

Python 3.7+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:
💻 Installation

```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:
```python
import sec_agent_sdk
```

### Setuptools
pip install git+ssh://[email protected]:CambioML/aisec.git#main

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
# Or

```sh
python setup.py install --user
poetry add git+ssh://[email protected]:CambioML/aisec.git#main
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import sec_agent_sdk
```

### Tests

Execute `pytest` to run the tests.

## Getting Started
🌱 Set up your AnyParser API key
Please reach out at [email protected] for an API key.

Please follow the [installation procedure](#installation--usage) and then run the following:
📜 Examples

```python
import sec_agent_sdk
Expand Down

0 comments on commit 702a627

Please sign in to comment.