An open API service indexing awesome lists of open source software.

https://github.com/brazil-data-cube/bdc-db

Database Management for Brazil Data Cube Applications and Services
https://github.com/brazil-data-cube/bdc-db

database flask-alembic flask-sqlalchemy postgresql python

Last synced: about 1 year ago
JSON representation

Database Management for Brazil Data Cube Applications and Services

Awesome Lists containing this project

README

          

..
This file is part of BDC-DB.
Copyright (C) 2022 INPE.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see .

============================================================================
Database Management Extension for Brazil Data Cube Applications and Services
============================================================================

.. image:: https://img.shields.io/badge/License-GPLv3-blue.svg
:target: https://github.com/brazil-data-cube/bdc-db/blob/master/LICENSE
:alt: Software License

.. image:: https://readthedocs.org/projects/bdc-db/badge/?version=latest
:target: https://bdc-db.readthedocs.io/en/latest
:alt: Documentation Status

.. image:: https://img.shields.io/badge/lifecycle-stable-green.svg
:target: https://www.tidyverse.org/lifecycle/#stable
:alt: Software Life Cycle

.. image:: https://img.shields.io/github/tag/brazil-data-cube/bdc-db.svg
:target: https://github.com/brazil-data-cube/bdc-db/releases
:alt: Release

.. image:: https://img.shields.io/discord/689541907621085198?logo=discord&logoColor=ffffff&color=7389D8
:target: https://discord.com/channels/689541907621085198#
:alt: Join us at Discord

About
=====

BDC-DB is a database management extension for Brazil Data Cube Applications and Services. It simplifies the work with `Flask-SQLAlchemy `_ model classes and `Alembic `_ migration scripts.

.. intro:

Other packages, applications and services can register database objects through standard Python entry point in ``setup.py``. See the `USAGE.rst <./USAGE.rst>`_ documentation on how to take advantage of this package.

Installation
============

See `INSTALL.rst <./INSTALL.rst>`_.

Usage
=====

See `USAGE.rst <./USAGE.rst>`_.

Repository Organization
=======================

See `REPOSITORY.rst `_.

Developer Documentation
=======================

See https://bdc-db.readthedocs.io/en/latest.

Thanks
======

This module is based on `Invenio-DB `_.
Thanks the Invenio Team for providing a scalable way to deal with dynamic database models with `Flask-SQLALchemy `_.

License
=======

.. admonition::
Copyright (C) 2022 INPE.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.