The Database Management Extension for Brazil Data Cube Applications and Services depends essentially on:
- Flask-SQLAlchemy: an extension for Flask that adds support for SQLAlchemy in applications.
- Flask-Migrate: used to handle SQLAlchemy database migrations with Alembic.
- SQLAlchemy-Utils: utility functions for SQLAlchemy such as database creation, database existence test, SQL script running.
Use git to clone the software repository:
git clone https://github.com/brazil-data-cube/bdc-db.git
Go to the source code folder:
cd bdc-db
Install in development mode:
pip3 install -e .[all]
Note
If you want to create a new Python Virtual Environment, please, follow this instruction:
1. Create a new virtual environment linked to Python 3.10:
python3.10 -m venv venv
2. Activate the new environment:
source venv/bin/activate
3. Update pip and setuptools:
pip3 install --upgrade pip setuptools wheel
You can generate the documentation based on Sphinx with the following command:
sphinx-build docs/sphinx docs/sphinx/_build/html
The above command will generate the documentation in HTML and it will place it under:
docs/sphinx/_build/html/
You can open the above documentation in your favorite browser, as:
firefox docs/sphinx/_build/html/index.html