Metadata-Version: 2.4
Name: fastapi-lazyrouter
Version: 0.1.0rc1
Summary: Lazy router implementation for FastAPI
License: MIT
License-File: LICENSE
Author: Fabien Arcellier
Author-email: fabien.arcellier@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Project-URL: Chat, https://discord.gg/xxxxx
Project-URL: Documentation, https://fastapi-lazyrouter.readthedocs.io/en/latest/
Project-URL: Issue Tracker, https://github.com/FabienArcellier/fastapi-lazyrouter/issues
Project-URL: Source code, https://github.com/FabienArcellier/fastapi-lazyrouter
Description-Content-Type: text/markdown

## fastapi-lazyrouter

[![ci](https://github.com/FabienArcellier/fastapi-lazyrouter/actions/workflows/main.yml/badge.svg)](https://github.com/FabienArcellier/fastapi-lazyrouter/actions/workflows/main.yml)

**Not implemented yet**

Lazy router implementation for FastAPI.

* code to share between several applications
* domain specific library
* compliant with different python version
* ...

## Getting started

1. clone this repository

2. remove .git directory

3. create a new git repository and push it on github

## The latest version

You can find the latest version to ...

```bash
git clone https://github.com/FabienArcellier/fastapi-lazyrouter.git
```

## Usage

You can run the application with the following command

```bash
from fastapi_lazyrouter import hello_world
hello_world()
```

### Publish the library on pypi

The publication use a tag-based workflow to run the publication on github action. First, a developper tag a commit using `alfred publish`, then github action publish the library on pypi.

The `alfred publish` take the version number from pyproject.toml. The command will raise an error if the current branch is not master, if changes are in progress, or if the tag already exists, if the branch is not synchronized with remote branch

```bash
alfred publish
```

### Run in docker container

You can run this template with docker. The manufactured image can be distributed and used to deploy your application to a production environment.

```bash
docker-compose build
docker-compose run app
```

### Run in gitpod

[gitpod](https://www.gitpod.io/) can be used as an IDE. You can load the code inside to try the code.

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/FabienArcellier/fastapi-lazyrouter)

## Developper guideline

### Add a dependency

``bash
poetry add requests
``
### Install development environment

Use make to instanciate a python virtual environment in ./venv and install the
python dependencies.

```bash
poetry install
```

### Update release dependencies

Use make to instanciate a python virtual environment in ./venv and freeze
dependencies version

```bash
poetry update update
```

### Activate the python environment

When you setup the requirements, a `venv` directory on python 3 is created.
To activate the venv, you have to execute :

```bash
poetry shell
```

### Run the continuous integration process

Before commit or send a pull request, you have to execute `pylint` to check the syntax
of your code and run the unit tests to validate the behavior.

```bash
$ poetry run alfred ci
```

### Rebuild the blueprint from scratch

I have to regularly rebuild it to update dependencies and refresh the skeleton documentation.

## Contributors

* Fabien Arcellier

## License

MIT License

Copyright (c) 2018-2023 Fabien Arcellier

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

