Metadata-Version: 2.1
Name: aigyminsper
Version: 0.1.6
Summary: A libray that helps you to learn Artificial Intelligence.
Author: Fabricio Barth
Author-email: fabriciojb@insper.edu.br
Description-Content-Type: text/markdown
License-File: LICENSE

# AIGYM

The goal of this libray is provide a set of tools to help you to learn Artificial Intelligence.

## How to setup the environment

To avoid any configuration problems, we recommend creating a virtual environment with python:

```bash
python3 -m virtualenv venv
source venv/bin/activate
python -m pip install --upgrade pip
pip install -r requirements.txt
```

To quit the virtual environment, type `deactivate`. If you already have the virtual environment configured then type `source venv/bin/activate`.

## How to test the project

To run the tests, please type in the root directory: 

```bash
export PYTHONPATH=.
pytest tests
```

## How to publish the package using PyPi

Change the version attribute in `setup.py` and then type: 

```bash
python setup.py sdist
twine upload dist/*
```

## How to upgrade the package

If you need to upgrade the package, please follow these steps: 

* change what you need in the code;
* test it :smile: ;
* describe what you did in the [Changelog.md](./Changelog.md) file;
* change the `setup.py` file. In special, the `version` attribute;
* type 

```bash
python setup.py sdist
twine upload dist/*
```

## How to install the package

```bash
pip install aigyminsper
```

## Change log

The change log of this library is in the [Changelog.md](./Changelog.md) file. 

## Documentation

The documentation of this library is in the [docs](./docs) folder. 
We are using [MkDocs](https://www.mkdocs.org/) to generate the documentation.

To see the documentation in your local machine, please type: 

```bash 
mkdocs serve
```

To deploy a new version of the documentation, please merge the content in the stable branch: 

```bash
git checkout stable
git merge master
git push
```

There is a GitHub Action that will deploy the documentation in the GitHub Pages.
