masq
/
halfapi
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
An ASGI framework to build HTTP API's from a Python module structure.
187 Commits 25 Branches 38 Tags 1.2 MiB
Python 99.7%
Dockerfile 0.2%
Go to file
Maxime Alves LIRMM 91ea25791b [doc] lib/domain.py annotation and comments 2020-10-07 09:54:09 +02:00
conf [release][0.1.0] First HalfAPI release 2020-07-23 17:54:47 +02:00
halfapi [doc] lib/domain.py annotation and comments 2020-10-07 09:54:09 +02:00
scripts [query] add fields list to query 2020-07-20 11:20:58 +02:00
tests [tests] fix tests according to abfaf2e1 2020-10-05 11:28:50 +02:00
.gitignore [router][api] Fix GET / 2020-09-29 15:08:35 +02:00
CHANGELOG.md [release][0.1.0] First HalfAPI release 2020-07-23 17:54:47 +02:00
LICENSE [release][0.1.0] First HalfAPI release 2020-07-23 17:54:47 +02:00
MANIFEST.in [package] fixed some paths 2020-08-27 09:54:48 +02:00
Pipfile Fix wrong dependency jwt -> pyjwt. 2020-10-05 11:39:55 +02:00
Pipfile.lock [style] rename exceptions (e) as exc (pep8 style) 2020-10-05 10:55:55 +02:00
README.md [doc] Update readme 2020-07-29 22:07:16 +02:00
pyproject.toml [deps] Updated dependencies and added files for standard packaging. 2020-07-29 22:07:16 +02:00
pytest.ini [routing] handle fqtn parameter in domain schema + get_api_routes (/) + /user -> /halfapi/current_user 2020-09-28 17:22:27 +02:00
requirements.txt [deps] jwt -> PyJWT 2020-08-07 02:08:22 +02:00
setup.cfg [deps] Updated dependencies and added files for standard packaging. 2020-07-29 22:07:16 +02:00
setup.py [deps] add orjson dependency 2020-09-24 20:48:52 +02:00

README.md

HalfAPI

This Python-based ASGI application aims to provide the core functionality to multiple API domains.

It's developed at the LIRMM in Montpellier, France.

The name "halfAPI" comes from the deep relationship between it and halfORM, a project authored by Joël Maizi.

You'll need a database with the API details. You can find the database model in halfapi/models/api.sql

TODO : include a token generation tool for testing purpose.

Dependencies

  • python3
  • python3-pip
  • libgit2-dev

Installing

With local folder :

pip3 install -r requirements.txt .[cli]

From the repository :

pip3 install git+ssh://git@gite.lirmm.fr:malves/halfapi.git[cli]

CLI usage

Running

Development mode

In the project's folder :

halfapi run

Production

The production server may use different init systems. As our main server is Debian-based, we use systemd services to manage the api server. Find the right service files and configure them properly in order to make your production setup perfect.

cp conf/systemd/lirmm_api* /etc/systemd/system/
systemctl daemon-reload
systemctl start lirmm_api

To make it start at boot :

systemctl enable lirmm_api

To get the logs :

journalctl -f --unit lirmm_api

Testing

Installing

pip3 install .[cli][tests]

Running

pytest -v