semvec/pypi-packages huggingface dataset:
recital 0.6.0
A client library for accessing recital
Requires Python: >=3.6,<4.0

# reciTAL Client

A client library for accessing reciTAL's API. :tada:

## Installation

It's easy. Don't worry.:smiley:

You just need to run the following:

```bash
pip install recital
```

## Usage

First, you'll need to create the client:

```python
from recital import RecitalClient

client = RecitalClient(username="username", password="password")
```

Now call your endpoint and use your models:

```python
from recital.models import MyDataModel
from recital.api.my_tag import get_my_data_model
from recital.types import Response

my_data: MyDataModel = get_my_data_model.sync(client=client)
# or if you need more info (e.g. status_code)
response: Response[MyDataModel] = get_my_data_model.sync_detailed(client=client)
```

Or do the same thing with an async version:

```python
from recital.models import MyDataModel
from recital.api.my_tag import get_my_data_model
from recital.types import Response

my_data: MyDataModel = await get_my_data_model.asyncio(client=client)
response: Response[MyDataModel] = await get_my_data_model.asyncio_detailed(client=client)
```

Things to know:
1. Every path/method combo becomes a Python module with four functions:
    1. `sync`: Blocking request that returns parsed data (if successful) or `None`
    1. `sync_detailed`: Blocking request that always returns a `Request`, optionally with `parsed` set if the request was successful.
    1. `asyncio`: Like `sync` but the async instead of blocking
    1. `asyncio_detailed`: Like `sync_detailed` by async instead of blocking

1. All path/query params, and bodies become method arguments.
1. If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)
1. Any endpoint which did not have a tag will be in `recital.api.default`

## Building / publishing this Client
This project uses [Poetry](https://python-poetry.org/) to manage dependencies  and packaging.  Here are the basics:
1. Update the metadata in pyproject.toml (e.g. authors, version)
1. If you're using a private repository, configure it with Poetry
    1. `poetry config repositories.<your-repository-name> <url-to-your-repository>`
    1. `poetry config http-basic.<your-repository-name> <username> <password>`
1. Publish the client with `poetry publish --build -r <your-repository-name>` or, if for public PyPI, just `poetry publish --build`

If you want to install this client into another project without publishing it (e.g. for development) then:
1. If that project **is using Poetry**, you can simply do `poetry add <path-to-this-client>` from that project
1. If that project is not using Poetry:
    1. Build a wheel with `poetry build -f wheel`
    1. Install that wheel from the other project `pip install <path-to-wheel>`
ihst 0.1.0
Minimal file hosting
Requires Python: >=3.6

# ihst

minimal file hosting

## Installation

1. Clone the repository
2. Run `python setup.py install`, or `run.py` if not deploying
3. Copy `config.example.yml` to `/etc/ihst/config.yml`

## License

ihst is licensed under version 3 of the GNU General Public License.
see [`LICENSE`](LICENSE) for details.