From ad550d3c43d830d4d8a58c21575aa55ddc69c949 Mon Sep 17 00:00:00 2001 From: Jedy Matt Tabasco Date: Sun, 26 Sep 2021 13:20:15 +0800 Subject: [PATCH] Bump version to 1.0.4 --- .readthedocs.yaml | 3 ++- docs/requirements.txt | 2 -- docs/source/api.rst | 1 - docs/source/index.rst | 29 ++--------------------------- docs/source/intro.rst | 14 +++++++------- docs/source/relationships.rst | 4 ++-- setup.cfg | 8 ++++++-- src/sqlalchemyseed/__init__.py | 2 +- 8 files changed, 20 insertions(+), 43 deletions(-) delete mode 100644 docs/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 1afbfca..914ef01 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -20,4 +20,5 @@ python: install: - method: pip path: . - - requirements: docs/requirements.txt \ No newline at end of file + extra_requirements: + - docs \ No newline at end of file diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index 5f4b4d3..0000000 --- a/docs/requirements.txt +++ /dev/null @@ -1,2 +0,0 @@ -sphinx-rtd-theme==1.0.0 -sphinx==4.2.0 \ No newline at end of file diff --git a/docs/source/api.rst b/docs/source/api.rst index 88e3eb1..365d5fc 100644 --- a/docs/source/api.rst +++ b/docs/source/api.rst @@ -27,7 +27,6 @@ Validators .. autofunction:: sqlalchemyseed.validator.validate - .. autofunction:: sqlalchemyseed.validator.hybrid_validate diff --git a/docs/source/index.rst b/docs/source/index.rst index fd064b3..eb7e87a 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -6,9 +6,9 @@ Welcome to sqlalchemyseed's documentation! ========================================== -|pypi| |versions| |license| |build-status| |code-quality| |coverage| +.. seealso:: -Project links: `Github`_ | `PyPI`_ + Project Links: `Github`_ | `PyPI`_ .. _Github: https://github.com/jedymatt/sqlalchemyseed .. _PyPI: https://pypi.org/project/sqlalchemyseed @@ -27,28 +27,3 @@ Indices and tables * :ref:`genindex` * :ref:`modindex` * :ref:`search` - - -.. |pypi| image:: https://img.shields.io/pypi/v/sqlalchemyseed - :alt: PyPI - :target: https://pypi.org/project/sqlalchemyseed/ - -.. |versions| image:: https://img.shields.io/pypi/pyversions/sqlalchemyseed - :alt: PyPI - Python Version - :target: https://pypi.org/project/sqlalchemyseed/ - -.. |license| image:: https://img.shields.io/pypi/l/sqlalchemyseed - :alt: PyPI - License - :target: https://github.com/jedymatt/sqlalchemyseed/blob/main/LICENSE - -.. |build-status| image:: https://app.travis-ci.com/jedymatt/sqlalchemyseed.svg?branch=main - :target: https://app.travis-ci.com/jedymatt/sqlalchemyseed - -.. |code-quality| image:: https://api.codeclimate.com/v1/badges/2ca97c98929b614658ea/maintainability - :target: https://codeclimate.com/github/jedymatt/sqlalchemyseed/maintainability - :alt: Maintainability - - -.. |coverage| image:: https://codecov.io/gh/jedymatt/sqlalchemyseed/branch/main/graph/badge.svg?token=W03MFZ2FAG - :target: https://codecov.io/gh/jedymatt/sqlalchemyseed - \ No newline at end of file diff --git a/docs/source/intro.rst b/docs/source/intro.rst index 25564f0..36e282e 100644 --- a/docs/source/intro.rst +++ b/docs/source/intro.rst @@ -4,7 +4,7 @@ Introduction `sqlalchemyseed`_ is a SQLAlchemy seeder that supports nested relationships with an easy to read text files. -Supported file types. +Supported file types : - json - yaml @@ -17,32 +17,32 @@ Installation Default installation -.. code-block:: console +.. code-block:: shell pip install sqlalchemyseed When using yaml to load entities from yaml files, execute this command to install necessary dependencies -.. code-block:: console +.. code-block:: shell pip install sqlalchemyseed[yaml] Dependencies ------------ -Required dependencies +Required dependencies: - SQAlchemy>=1.4.0 -Optional dependencies +Optional dependencies: - yaml - PyYAML>=5.4.0 -Getting Started ---------------- +Quickstart +---------- Here's a simple snippet to get started from ``main.py`` file. diff --git a/docs/source/relationships.rst b/docs/source/relationships.rst index 6615dc3..0f035b3 100644 --- a/docs/source/relationships.rst +++ b/docs/source/relationships.rst @@ -1,5 +1,5 @@ -Relationships -============= +Referencing Relationships +========================== To add reference attribute, add prefix to the attribute to differentiate reference attribute from normal ones. diff --git a/setup.cfg b/setup.cfg index bddf392..19a6308 100644 --- a/setup.cfg +++ b/setup.cfg @@ -15,7 +15,8 @@ classifiers = Programming Language :: Python :: 3.7 Programming Language :: Python :: 3.8 Programming Language :: Python :: 3.9 -project_urls = +project_urls = + Documentation = https://sqlalchemyseed.readthedocs.io/ Source = https://github.com/jedymatt/sqlalchemyseed Tracker = https://github.com/jedymatt/sqlalchemyseed/issues keywords = sqlalchemy, orm, seed, seeder, json, yaml @@ -33,4 +34,7 @@ where = src [options.extras_require] yaml = - PyYAML>=5.4 \ No newline at end of file + PyYAML>=5.4 +docs = + sphinx-rtd-theme>=1.0 + sphinx>=4.2 \ No newline at end of file diff --git a/src/sqlalchemyseed/__init__.py b/src/sqlalchemyseed/__init__.py index bb44555..7019a82 100644 --- a/src/sqlalchemyseed/__init__.py +++ b/src/sqlalchemyseed/__init__.py @@ -29,7 +29,7 @@ from .loader import load_entities_from_csv -__version__ = "1.0.3" +__version__ = "1.0.4" if __name__ == '__main__': pass