diff --git a/docs/source/conf.py b/docs/source/conf.py index 2d6cf6258ad672c41d8b6125666be68b68b6e857..2703c4254eba24a09f24aba4b66f417e2f4d198e 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -22,7 +22,7 @@ copyright = '2022, Brandon Rodriguez' author = 'Brandon Rodriguez' # The full version, including alpha/beta/rc tags -release = '0.1.0' +release = '0.2.0' # -- General configuration --------------------------------------------------- diff --git a/docs/source/index.rst b/docs/source/index.rst index e5a35008d8951e216c8e928d69a90b43c5b037df..9ca947077562a6e5733de45d5f539b871111994a 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -18,6 +18,13 @@ connector to allow Pythonic interaction with multiple database types. quickstart configuration +.. toctree:: + :maxdepth: 1 + :caption: Versions: + + roadmap + version_history + Indices and tables ================== diff --git a/docs/source/roadmap.rst b/docs/source/roadmap.rst new file mode 100644 index 0000000000000000000000000000000000000000..31b87bd8684037675dfb7255e77689ece3f535af --- /dev/null +++ b/docs/source/roadmap.rst @@ -0,0 +1,20 @@ +Expected Roadmap +**************** + +Below is the minimum viable state for each version release. + + +* v 0.2.x + + * Project is in a minimal viable state to import and use in other projects, + if only for standard **MySQL** databases. + +* v 0.3.x + + * Project is in viable state to import and use in other projects, + for both **MySQL** and **PostgreSQL** databases. + +* v 0.4.x + + * Project is in viable state to import and use in other projects, + for **MySQL**, **PostgreSQL**, and **SqLite** databases. diff --git a/docs/source/version_history.rst b/docs/source/version_history.rst new file mode 100644 index 0000000000000000000000000000000000000000..78230df9a7229bae92a552f137357c2535af5da3 --- /dev/null +++ b/docs/source/version_history.rst @@ -0,0 +1,26 @@ +Version History +*************** + + +0.2.0 - Stable MySQL Querying +============================= + +* **MySQL** connections have been more thoroughly tested, and project + setup/syntax is considered generally stable. + + * **PostgreSQL** connections have been started, but are incomplete. + +* Added basic output coloring and output show/hide args. +* Query validation logic could still use work, but is partially implemented. +* Has been tested in a live project and seems to have desired functionality, + so long as queries are fairly basic (only basic SHOW/SELECT/UPDATE/DELETE). + These queries have been implemented for each of Database/Table/Record level. + + +0.1.0 - Initial Release +======================= + +* First release. +* Very much WIP and subject to change. +* Minimal functionality. +* Not recommended for import/use in a live production project. diff --git a/pyproject.toml b/pyproject.toml index 06ba01e6eb7f9246c433f8a44ab8ee9d40046807..d4e848aef58c7704cde53b76f673f8dc4ba07f0a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = 'setuptools.build_meta:__legacy__' [project] name = "py-dbcn" -version = "0.1.0" +version = "0.2.0" description = "Connector for Pythonic interaction with multiple database types." readme = "readme.md" authors = [{ name = "Brandon Rodriguez", email = "brodriguez8774@gmail.com"}] @@ -26,6 +26,7 @@ keywords = [ "mysql", ] dependencies = [ + "colorama", "mysqlclient", ] requires-python = ">=3.7" diff --git a/setup.cfg b/setup.cfg index 470c4155a123ed5fe6022371807b325342a2fcdc..313bb38c0782fe5b50250cc37b6a104a4680ea60 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,6 +1,6 @@ [metadata] name = py-dbcn -version = 0.1.0 +version = 0.2.0 description = Connector for Pythonic interaction with multiple database types. long_description = file: readme.md url = https://github.com/brodriguez8774/py-dbcn