semvec/pypi-packages huggingface dataset:
aisrv 0.1.dev0
AI API
Requires Python: >=3.8

======
AI-API
======

Copyright (c) 2023 Jérémie DECOCK (www.jdhp.org)

* Web site: http://www.jdhp.org/software_en.html#aiapi
* Online documentation: https://jdhp-dev.gitlab.io/aiapi
* Examples: https://jdhp-dev.gitlab.io/aiapi/gallery/

* Notebooks: https://gitlab.com/jdhp-dev/ai-api-notebooks
* Source code: https://gitlab.com/jdhp-dev/ai-api
* Issue tracker: https://gitlab.com/jdhp-dev/ai-api/issues
* Pytest code coverage: https://jdhp-dev.gitlab.io/aiapi/htmlcov/index.html
* AI-API on PyPI: https://pypi.org/project/aiapi


Description
===========

AI API

Note:

    This project is still in beta stage, so the API is not finalized yet.


Dependencies
============

C.f. requirements.txt


.. _install:

Installation (development environment)
======================================

Posix (Linux, MacOSX, WSL, ...)
-------------------------------

From the AI-API source code::

    conda deactivate         # Only if you use Anaconda...
    python3 -m venv env
    source env/bin/activate
    python3 -m pip install --upgrade pip
    python3 -m pip install -r requirements-dev.txt


Windows
-------

From the AI-API source code::

    conda deactivate         # Only if you use Anaconda...
    python3 -m venv env
    env\Scripts\activate.bat
    python3 -m pip install --upgrade pip
    python3 -m pip install -r requirements-dev.txt


Installation (production environment)
=====================================

::

    python3 -m pip install --no-cache-dir "aiapi @ git+ssh://git@gitlab.com/jdhp-dev/ai-api.git"


Documentation
=============

* Online documentation: https://jdhp-dev.gitlab.io/aiapi
* API documentation: https://jdhp-dev.gitlab.io/aiapi/api.html


Example usage
=============

* Examples: https://jdhp-dev.gitlab.io/aiapi/gallery/


Build and run the Python Docker image
=====================================

Build the docker image
----------------------

From the AI-API source code::

    docker build -t aiapi:latest .

Run unit tests from the docker container
----------------------------------------

From the AI-API source code::

    docker run aiapi pytest

Run an example from the docker container
----------------------------------------

From the AI-API source code::

    docker run aiapi python3 /app/examples/hello.py


Bug reports
===========

To search for bugs or report them, please use the AI-API Bug Tracker at:

    https://gitlab.com/jdhp-dev/ai-api/issues


License
=======

This project is provided under the terms and conditions of the `MIT License`_.


.. _MIT License: http://opensource.org/licenses/MIT
.. _command prompt: https://en.wikipedia.org/wiki/Cmd.exe
bpmn_parser 0.1.0
A simple BPMN Parser implemented in Python
Requires Python: <4.0,>=3.10

# bpmn_parser

[![Tests and Linting](https://github.com/danbailo/bpmn-parser/actions/workflows/tests.yaml/badge.svg?branch=main)](https://github.com/danbailo/bpmn-parser/actions/workflows/tests.yaml) ![Coverage Status](./assets/coverage-badge.svg)

Simple structure that I([@danbailo](https://github.com/danbailo)) like use to build projects.

enjoy and... Python 🐍 for everthing 😄

## Make
The project uses a [Makefile](Makefile) to facilitate project installation, lint execution, typing and testing.

### Preparing virtual enviroment

It is highly recommended to use virtual environments when developing Python projects.

### Using poetry

Install [poetry](https://github.com/python-poetry/poetry) then install the project using Make.

```
make install
```

### Using pyenv

Install the [prerequisites](https://github.com/pyenv/pyenv/wiki/Common-build-problems#prerequisites) and then install [pyenv](https://github.com/pyenv/pyenv-installer). After install and configure pyenv, just install the project using Make.

```
make prepare_env_pyenv
```

then

```
make install
```

### Checkers

`make check_format` - Checks code formatting.

`make format` - Automatically formats the code.

`make check_lint` - Checks the code lint.

`make lint` - Formats the code by automatically correcting the lint.

`make check_types` - Checks the typing hinting of the code.

`make tests` - Runs the project's tests.

`make check_all` - Runs all the project's "checkers" and tests signaling when everything is ok. This way, it is certain that the pull-request pipeline will be ready to go to main.

All settings defined in formatting, typing, lint, etc. They are defined in the Python project configuration file - [pyproject.toml](pyproject.toml).