SQLALCHEMY INITDB
Django like fixtures for SQLAlchemy
.. start-badges
| |build| |docs| |coverage| |maintainability| |tech-debt|
| |release_version| |wheel| |supported_versions| |gh-lic| |commits_since_specific_tag_on_master| |commits_since_latest_github_release|
|
| **Code:** https://github.com/dnmellen/sqlalchemy-initdb
| **Docs:** https://sqlalchemy-initdb.readthedocs.io/en/master/
| **PyPI:** https://pypi.org/project/sqlalchemy-initdb/
| **CI:** https://github.com/dnmellen/sqlalchemy-initdb/actions/
Features
========
1. **sqlalchemy_initdb** `python package`
a. TODO Document a **Great Feature**
b. TODO Document another **Nice Feature**
2. Tested against multiple `platforms` and `python` versions
Development
-----------
Here are some useful notes related to doing development on this project.
1. **Test Suite**, using `pytest`_, located in `tests` dir
2. **Parallel Execution** of Unit Tests, on multiple cpu's
3. **Documentation Pages**, hosted on `readthedocs` server, located in `docs` dir
4. **Automation**, using `tox`_, driven by single `tox.ini` file
a. **Code Coverage** measuring
b. **Build Command**, using the `build`_ python package
c. **Pypi Deploy Command**, supporting upload to both `pypi.org`_ and `test.pypi.org`_ servers
d. **Type Check Command**, using `mypy`_
e. **Lint** *Check* and `Apply` commands, using `isort`_ and `black`_
5. **CI Pipeline**, running on `Github Actions`_, defined in `.github/`
a. **Job Matrix**, spanning different `platform`'s and `python version`'s
1. Platforms: `ubuntu-latest`, `macos-latest`
2. Python Interpreters: `3.6`, `3.7`, `3.8`, `3.9`, `3.10`
b. **Parallel Job** execution, generated from the `matrix`, that runs the `Test Suite`
Prerequisites
=============
You need to have `Python` installed.
Quickstart
==========
Using `pip` is the approved way for installing `sqlalchemy_initdb`.
.. code-block:: sh
python3 -m pip install sqlalchemy_initdb
TODO Document a use case
License
=======
|gh-lic|
* `GNU Affero General Public License v3.0`_
License
=======
* Free software: GNU Affero General Public License v3.0
.. LINKS
.. _tox: https://tox.wiki/en/latest/
.. _pytest: https://docs.pytest.org/en/7.1.x/
.. _build: https://github.com/pypa/build
.. _pypi.org: https://pypi.org/
.. _test.pypi.org: https://test.pypi.org/
.. _mypy: https://mypy.readthedocs.io/en/stable/
.. _isort: https://pycqa.github.io/isort/
.. _black: https://black.readthedocs.io/en/stable/
.. _Github Actions: https://github.com/dnmellen/sqlalchemy-initdb/actions
.. _GNU Affero General Public License v3.0: https://github.com/dnmellen/sqlalchemy-initdb/blob/master/LICENSE
.. BADGE ALIASES
.. Build Status
.. Github Actions: Test Workflow Status for specific branch <branch>
.. |build| image:: https://img.shields.io/github/workflow/status/dnmellen/sqlalchemy-initdb/Test%20Python%20Package/master?label=build&logo=github-actions&logoColor=%233392FF
:alt: GitHub Workflow Status (branch)
:target: https://github.com/dnmellen/sqlalchemy-initdb/actions/workflows/test.yaml?query=branch%3Amaster
.. Documentation
.. |docs| image:: https://img.shields.io/readthedocs/sqlalchemy-initdb/master?logo=readthedocs&logoColor=lightblue
:alt: Read the Docs (version)
:target: https://sqlalchemy-initdb.readthedocs.io/en/master/
.. Code Coverage
.. |coverage| image:: https://img.shields.io/codecov/c/github/dnmellen/sqlalchemy-initdb/master?logo=codecov
:alt: Codecov
:target: https://app.codecov.io/gh/dnmellen/sqlalchemy-initdb
.. PyPI
.. |release_version| image:: https://img.shields.io/pypi/v/sqlalchemy_initdb
:alt: Production Version
:target: https://pypi.org/project/sqlalchemy-initdb/
.. |wheel| image:: https://img.shields.io/pypi/wheel/sqlalchemy-initdb?color=green&label=wheel
:alt: PyPI - Wheel
:target: https://pypi.org/project/sqlalchemy-initdb
.. |supported_versions| image:: https://img.shields.io/pypi/pyversions/sqlalchemy-initdb?color=blue&label=python&logo=python&logoColor=%23ccccff
:alt: Supported Python versions
:target: https://pypi.org/project/sqlalchemy-initdb
.. Github Releases & Tags
.. |commits_since_specific_tag_on_master| image:: https://img.shields.io/github/commits-since/dnmellen/sqlalchemy-initdb/v0.0.1/master?color=blue&logo=github
:alt: GitHub commits since tagged version (branch)
:target: https://github.com/dnmellen/sqlalchemy-initdb/compare/v0.0.1..master
.. |commits_since_latest_github_release| image:: https://img.shields.io/github/commits-since/dnmellen/sqlalchemy-initdb/latest?color=blue&logo=semver&sort=semver
:alt: GitHub commits since latest release (by SemVer)
.. LICENSE (eg AGPL, MIT)
.. Github License
.. |gh-lic| image:: https://img.shields.io/github/license/dnmellen/sqlalchemy-initdb
:alt: GitHub
:target: https://github.com/dnmellen/sqlalchemy-initdb/blob/master/LICENSE
.. CODE QUALITY
.. Code Climate CI
.. Code maintainability & Technical Debt
.. |maintainability| image:: https://img.shields.io/codeclimate/maintainability/dnmellen/sqlalchemy-initdb
:alt: Code Climate Maintainability
:target: https://codeclimate.com/github/dnmellen/sqlalchemy-initdb
.. |tech-debt| image:: https://img.shields.io/codeclimate/tech-debt/dnmellen/sqlalchemy-initdb
:alt: Technical Debt
:target: https://codeclimate.com/github/dnmellen/sqlalchemy-initdb
Raw data
{
"_id": null,
"home_page": "https://github.com/dnmellen/sqlalchemy-initdb",
"name": "sqlalchemy-initdb",
"maintainer": "Diego Navarro",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "dnmellen@gmail.com",
"keywords": "python package",
"author": "Diego Navarro",
"author_email": "dnmellen@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/30/b2/370cf1313f759e044e9de8ef0c9c73f4f8b23da0366ffe1d752915d5c5ec/sqlalchemy_initdb-0.1.0.tar.gz",
"platform": null,
"description": "SQLALCHEMY INITDB\n\nDjango like fixtures for SQLAlchemy\n\n.. start-badges\n\n| |build| |docs| |coverage| |maintainability| |tech-debt|\n| |release_version| |wheel| |supported_versions| |gh-lic| |commits_since_specific_tag_on_master| |commits_since_latest_github_release|\n\n|\n| **Code:** https://github.com/dnmellen/sqlalchemy-initdb\n| **Docs:** https://sqlalchemy-initdb.readthedocs.io/en/master/\n| **PyPI:** https://pypi.org/project/sqlalchemy-initdb/\n| **CI:** https://github.com/dnmellen/sqlalchemy-initdb/actions/\n\n\nFeatures\n========\n\n1. **sqlalchemy_initdb** `python package`\n\n a. TODO Document a **Great Feature**\n b. TODO Document another **Nice Feature**\n2. Tested against multiple `platforms` and `python` versions\n\n\nDevelopment\n-----------\nHere are some useful notes related to doing development on this project.\n\n1. **Test Suite**, using `pytest`_, located in `tests` dir\n2. **Parallel Execution** of Unit Tests, on multiple cpu's\n3. **Documentation Pages**, hosted on `readthedocs` server, located in `docs` dir\n4. **Automation**, using `tox`_, driven by single `tox.ini` file\n\n a. **Code Coverage** measuring\n b. **Build Command**, using the `build`_ python package\n c. **Pypi Deploy Command**, supporting upload to both `pypi.org`_ and `test.pypi.org`_ servers\n d. **Type Check Command**, using `mypy`_\n e. **Lint** *Check* and `Apply` commands, using `isort`_ and `black`_\n5. **CI Pipeline**, running on `Github Actions`_, defined in `.github/`\n\n a. **Job Matrix**, spanning different `platform`'s and `python version`'s\n\n 1. Platforms: `ubuntu-latest`, `macos-latest`\n 2. Python Interpreters: `3.6`, `3.7`, `3.8`, `3.9`, `3.10`\n b. **Parallel Job** execution, generated from the `matrix`, that runs the `Test Suite`\n\n\nPrerequisites\n=============\n\nYou need to have `Python` installed.\n\nQuickstart\n==========\n\nUsing `pip` is the approved way for installing `sqlalchemy_initdb`.\n\n.. code-block:: sh\n\n python3 -m pip install sqlalchemy_initdb\n\n\nTODO Document a use case\n\n\nLicense\n=======\n\n|gh-lic|\n\n* `GNU Affero General Public License v3.0`_\n\n\nLicense\n=======\n\n* Free software: GNU Affero General Public License v3.0\n\n\n\n.. LINKS\n\n.. _tox: https://tox.wiki/en/latest/\n\n.. _pytest: https://docs.pytest.org/en/7.1.x/\n\n.. _build: https://github.com/pypa/build\n\n.. _pypi.org: https://pypi.org/\n\n.. _test.pypi.org: https://test.pypi.org/\n\n.. _mypy: https://mypy.readthedocs.io/en/stable/\n\n.. _isort: https://pycqa.github.io/isort/\n\n.. _black: https://black.readthedocs.io/en/stable/\n\n.. _Github Actions: https://github.com/dnmellen/sqlalchemy-initdb/actions\n\n.. _GNU Affero General Public License v3.0: https://github.com/dnmellen/sqlalchemy-initdb/blob/master/LICENSE\n\n\n.. BADGE ALIASES\n\n.. Build Status\n.. Github Actions: Test Workflow Status for specific branch <branch>\n\n.. |build| image:: https://img.shields.io/github/workflow/status/dnmellen/sqlalchemy-initdb/Test%20Python%20Package/master?label=build&logo=github-actions&logoColor=%233392FF\n :alt: GitHub Workflow Status (branch)\n :target: https://github.com/dnmellen/sqlalchemy-initdb/actions/workflows/test.yaml?query=branch%3Amaster\n\n\n.. Documentation\n\n.. |docs| image:: https://img.shields.io/readthedocs/sqlalchemy-initdb/master?logo=readthedocs&logoColor=lightblue\n :alt: Read the Docs (version)\n :target: https://sqlalchemy-initdb.readthedocs.io/en/master/\n\n.. Code Coverage\n\n.. |coverage| image:: https://img.shields.io/codecov/c/github/dnmellen/sqlalchemy-initdb/master?logo=codecov\n :alt: Codecov\n :target: https://app.codecov.io/gh/dnmellen/sqlalchemy-initdb\n\n.. PyPI\n\n.. |release_version| image:: https://img.shields.io/pypi/v/sqlalchemy_initdb\n :alt: Production Version\n :target: https://pypi.org/project/sqlalchemy-initdb/\n\n.. |wheel| image:: https://img.shields.io/pypi/wheel/sqlalchemy-initdb?color=green&label=wheel\n :alt: PyPI - Wheel\n :target: https://pypi.org/project/sqlalchemy-initdb\n\n.. |supported_versions| image:: https://img.shields.io/pypi/pyversions/sqlalchemy-initdb?color=blue&label=python&logo=python&logoColor=%23ccccff\n :alt: Supported Python versions\n :target: https://pypi.org/project/sqlalchemy-initdb\n\n.. Github Releases & Tags\n\n.. |commits_since_specific_tag_on_master| image:: https://img.shields.io/github/commits-since/dnmellen/sqlalchemy-initdb/v0.0.1/master?color=blue&logo=github\n :alt: GitHub commits since tagged version (branch)\n :target: https://github.com/dnmellen/sqlalchemy-initdb/compare/v0.0.1..master\n\n.. |commits_since_latest_github_release| image:: https://img.shields.io/github/commits-since/dnmellen/sqlalchemy-initdb/latest?color=blue&logo=semver&sort=semver\n :alt: GitHub commits since latest release (by SemVer)\n\n.. LICENSE (eg AGPL, MIT)\n.. Github License\n\n.. |gh-lic| image:: https://img.shields.io/github/license/dnmellen/sqlalchemy-initdb\n :alt: GitHub\n :target: https://github.com/dnmellen/sqlalchemy-initdb/blob/master/LICENSE\n\n\n.. CODE QUALITY\n\n.. Code Climate CI\n.. Code maintainability & Technical Debt\n\n.. |maintainability| image:: https://img.shields.io/codeclimate/maintainability/dnmellen/sqlalchemy-initdb\n :alt: Code Climate Maintainability\n :target: https://codeclimate.com/github/dnmellen/sqlalchemy-initdb\n\n.. |tech-debt| image:: https://img.shields.io/codeclimate/tech-debt/dnmellen/sqlalchemy-initdb\n :alt: Technical Debt\n :target: https://codeclimate.com/github/dnmellen/sqlalchemy-initdb\n\n",
"bugtrack_url": null,
"license": "AGPL-3.0-only",
"summary": "Django like fixtures for SQLAlchemy",
"version": "0.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/sqlalchemy-initdb/issues",
"CI: Github Actions": "https://github.com/dnmellen/sqlalchemy-initdb/actions",
"Changelog": "https://github.com/dnmellen/sqlalchemy-initdb/blob/master/CHANGELOG.rst",
"Code of Conduct": "https://github.com/dnmellen/sqlalchemy-initdb/blob/master/CONTRIBUTING.rst",
"Documentation": "https://sqlalchemy-initdb.readthedocs.io/",
"Homepage": "https://github.com/dnmellen/sqlalchemy-initdb",
"Repository": "https://github.com/dnmellen/sqlalchemy-initdb",
"Source Code": "https://github.com/dnmellen/sqlalchemy-initdb"
},
"split_keywords": [
"python",
"package"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6699672d2ea87a9958ae8586ad82c5274ac696f6863edd82e424a557bc070c80",
"md5": "dfbf6d2875e993a3e9991c2e4966f2f9",
"sha256": "0d03229544aa9ef9172644876b03b596fe586620429e543028ea09252dcb10a2"
},
"downloads": -1,
"filename": "sqlalchemy_initdb-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dfbf6d2875e993a3e9991c2e4966f2f9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 37929,
"upload_time": "2023-08-13T15:42:43",
"upload_time_iso_8601": "2023-08-13T15:42:43.234455Z",
"url": "https://files.pythonhosted.org/packages/66/99/672d2ea87a9958ae8586ad82c5274ac696f6863edd82e424a557bc070c80/sqlalchemy_initdb-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "30b2370cf1313f759e044e9de8ef0c9c73f4f8b23da0366ffe1d752915d5c5ec",
"md5": "d05396546ed1a964997846f7757fbc74",
"sha256": "5071b3597962e83bcf3bede27baffaf0347a55cd20ff7400e00a63ec21f85ae4"
},
"downloads": -1,
"filename": "sqlalchemy_initdb-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "d05396546ed1a964997846f7757fbc74",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 25843,
"upload_time": "2023-08-13T15:42:44",
"upload_time_iso_8601": "2023-08-13T15:42:44.991352Z",
"url": "https://files.pythonhosted.org/packages/30/b2/370cf1313f759e044e9de8ef0c9c73f4f8b23da0366ffe1d752915d5c5ec/sqlalchemy_initdb-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-13 15:42:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dnmellen",
"github_project": "sqlalchemy-initdb",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "sqlalchemy-initdb"
}
JSON
