From 497b022c70dc41e248382a316b1f75f4afb45176 Mon Sep 17 00:00:00 2001 From: robml Date: Mon, 9 Mar 2020 10:28:18 +0400 Subject: [PATCH] Updated README and files for PyPi installment as well --- README.md | 9 +++++---- README.rst | 4 ++-- __init__.py => django_dbaccounting/__init__.py | 0 admin.py => django_dbaccounting/admin.py | 0 apps.py => django_dbaccounting/apps.py | 0 forms.py => django_dbaccounting/forms.py | 0 .../migrations}/0001_initial.py | 0 .../migrations}/0002_auto_20200303_2358.py | 0 .../migrations}/0003_auto_20200304_0000.py | 0 .../migrations}/0004_auto_20200305_0001.py | 0 .../migrations}/0005_accounttype_parent.py | 0 .../migrations}/0006_account_date_create.py | 0 .../migrations}/0007_auto_20200306_2118.py | 0 .../migrations}/0008_transaction_updating.py | 0 .../migrations}/0009_transaction_edited.py | 0 .../migrations}/0010_auto_20200307_1933.py | 0 .../migrations}/__init__.py | 0 models.py => django_dbaccounting/models.py | 0 .../static}/css/styles.css | 0 .../templates}/base_generic.html | 0 .../dbaccounting/account_confirm_delete.html | 0 .../templates}/dbaccounting/account_detail.html | 0 .../templates}/dbaccounting/account_form.html | 0 .../templates}/dbaccounting/account_list.html | 0 .../dbaccounting/accounttype_confirm_delete.html | 0 .../templates}/dbaccounting/accounttype_detail.html | 0 .../templates}/dbaccounting/accounttype_form.html | 0 .../templates}/dbaccounting/accounttype_list.html | 0 .../templates}/dbaccounting/balance_sheet.html | 0 .../templates}/dbaccounting/cashflow.html | 0 .../templates}/dbaccounting/debt.html | 0 .../templates}/dbaccounting/forecast.html | 0 .../templates}/dbaccounting/income_statement.html | 0 .../templates}/dbaccounting/report.html | 0 .../templates}/dbaccounting/retained_earnings.html | 0 .../dbaccounting/transaction_confirm_delete.html | 0 .../templates}/dbaccounting/transaction_detail.html | 0 .../templates}/dbaccounting/transaction_form.html | 0 .../templates}/dbaccounting/transaction_list.html | 0 .../templates}/index.html | 0 {tests => django_dbaccounting/tests}/__init__.py | 0 {tests => django_dbaccounting/tests}/test_forms.py | 0 {tests => django_dbaccounting/tests}/test_models.py | 0 {tests => django_dbaccounting/tests}/test_views.py | 0 urls.py => django_dbaccounting/urls.py | 0 views.py => django_dbaccounting/views.py | 0 setup.cfg | 5 +++-- setup.py | 12 +++++++++++- 48 files changed, 21 insertions(+), 9 deletions(-) rename __init__.py => django_dbaccounting/__init__.py (100%) rename admin.py => django_dbaccounting/admin.py (100%) rename apps.py => django_dbaccounting/apps.py (100%) rename forms.py => django_dbaccounting/forms.py (100%) rename {migrations => django_dbaccounting/migrations}/0001_initial.py (100%) rename {migrations => django_dbaccounting/migrations}/0002_auto_20200303_2358.py (100%) rename {migrations => django_dbaccounting/migrations}/0003_auto_20200304_0000.py (100%) rename {migrations => django_dbaccounting/migrations}/0004_auto_20200305_0001.py (100%) rename {migrations => django_dbaccounting/migrations}/0005_accounttype_parent.py (100%) rename {migrations => django_dbaccounting/migrations}/0006_account_date_create.py (100%) rename {migrations => django_dbaccounting/migrations}/0007_auto_20200306_2118.py (100%) rename {migrations => django_dbaccounting/migrations}/0008_transaction_updating.py (100%) rename {migrations => django_dbaccounting/migrations}/0009_transaction_edited.py (100%) rename {migrations => django_dbaccounting/migrations}/0010_auto_20200307_1933.py (100%) rename {migrations => django_dbaccounting/migrations}/__init__.py (100%) rename models.py => django_dbaccounting/models.py (100%) rename {static => django_dbaccounting/static}/css/styles.css (100%) rename {templates => django_dbaccounting/templates}/base_generic.html (100%) rename {templates => django_dbaccounting/templates}/dbaccounting/account_confirm_delete.html (100%) rename {templates => django_dbaccounting/templates}/dbaccounting/account_detail.html (100%) rename {templates => django_dbaccounting/templates}/dbaccounting/account_form.html (100%) rename {templates => django_dbaccounting/templates}/dbaccounting/account_list.html (100%) rename {templates => django_dbaccounting/templates}/dbaccounting/accounttype_confirm_delete.html (100%) rename {templates => django_dbaccounting/templates}/dbaccounting/accounttype_detail.html (100%) rename {templates => django_dbaccounting/templates}/dbaccounting/accounttype_form.html (100%) rename {templates => django_dbaccounting/templates}/dbaccounting/accounttype_list.html (100%) rename {templates => django_dbaccounting/templates}/dbaccounting/balance_sheet.html (100%) rename {templates => django_dbaccounting/templates}/dbaccounting/cashflow.html (100%) rename {templates => django_dbaccounting/templates}/dbaccounting/debt.html (100%) rename {templates => django_dbaccounting/templates}/dbaccounting/forecast.html (100%) rename {templates => django_dbaccounting/templates}/dbaccounting/income_statement.html (100%) rename {templates => django_dbaccounting/templates}/dbaccounting/report.html (100%) rename {templates => django_dbaccounting/templates}/dbaccounting/retained_earnings.html (100%) rename {templates => django_dbaccounting/templates}/dbaccounting/transaction_confirm_delete.html (100%) rename {templates => django_dbaccounting/templates}/dbaccounting/transaction_detail.html (100%) rename {templates => django_dbaccounting/templates}/dbaccounting/transaction_form.html (100%) rename {templates => django_dbaccounting/templates}/dbaccounting/transaction_list.html (100%) rename {templates => django_dbaccounting/templates}/index.html (100%) rename {tests => django_dbaccounting/tests}/__init__.py (100%) rename {tests => django_dbaccounting/tests}/test_forms.py (100%) rename {tests => django_dbaccounting/tests}/test_models.py (100%) rename {tests => django_dbaccounting/tests}/test_views.py (100%) rename urls.py => django_dbaccounting/urls.py (100%) rename views.py => django_dbaccounting/views.py (100%) diff --git a/README.md b/README.md index bd3e33d..85154ad 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,8 @@ # django_dbaccounting A Python based accounting core built with Django -==== DB Accounting -==== +============== DB Accounting is a Django app that provides a core for accounting and account management. Although developed primarily for accounting purposes, the flexible nature of DB Accounting, @@ -15,9 +14,9 @@ Quick start ----------- If you are only looking to install the python package, use: -- pip install db-accounting (under maintenance, resolving with Python Packaging Authority) +- pip install db-accounting - download the .tar file from Github -- install it from DjangoPackages.org (pending PyPi issue mentioned above) +- install it from DjangoPackages.org To configure: @@ -58,3 +57,5 @@ Best, Robert M. Reach me on instagram: @officialrobmel or @quantrobbie + +See my Github: @robml diff --git a/README.rst b/README.rst index ef327e9..00290fa 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,6 @@ -==== + DB Accounting -==== +============== DB Accounting is a Django app that provides a core for accounting and account management. Although developed primarily for accounting purposes, the flexible nature of DB Accounting, diff --git a/__init__.py b/django_dbaccounting/__init__.py similarity index 100% rename from __init__.py rename to django_dbaccounting/__init__.py diff --git a/admin.py b/django_dbaccounting/admin.py similarity index 100% rename from admin.py rename to django_dbaccounting/admin.py diff --git a/apps.py b/django_dbaccounting/apps.py similarity index 100% rename from apps.py rename to django_dbaccounting/apps.py diff --git a/forms.py b/django_dbaccounting/forms.py similarity index 100% rename from forms.py rename to django_dbaccounting/forms.py diff --git a/migrations/0001_initial.py b/django_dbaccounting/migrations/0001_initial.py similarity index 100% rename from migrations/0001_initial.py rename to django_dbaccounting/migrations/0001_initial.py diff --git a/migrations/0002_auto_20200303_2358.py b/django_dbaccounting/migrations/0002_auto_20200303_2358.py similarity index 100% rename from migrations/0002_auto_20200303_2358.py rename to django_dbaccounting/migrations/0002_auto_20200303_2358.py diff --git a/migrations/0003_auto_20200304_0000.py b/django_dbaccounting/migrations/0003_auto_20200304_0000.py similarity index 100% rename from migrations/0003_auto_20200304_0000.py rename to django_dbaccounting/migrations/0003_auto_20200304_0000.py diff --git a/migrations/0004_auto_20200305_0001.py b/django_dbaccounting/migrations/0004_auto_20200305_0001.py similarity index 100% rename from migrations/0004_auto_20200305_0001.py rename to django_dbaccounting/migrations/0004_auto_20200305_0001.py diff --git a/migrations/0005_accounttype_parent.py b/django_dbaccounting/migrations/0005_accounttype_parent.py similarity index 100% rename from migrations/0005_accounttype_parent.py rename to django_dbaccounting/migrations/0005_accounttype_parent.py diff --git a/migrations/0006_account_date_create.py b/django_dbaccounting/migrations/0006_account_date_create.py similarity index 100% rename from migrations/0006_account_date_create.py rename to django_dbaccounting/migrations/0006_account_date_create.py diff --git a/migrations/0007_auto_20200306_2118.py b/django_dbaccounting/migrations/0007_auto_20200306_2118.py similarity index 100% rename from migrations/0007_auto_20200306_2118.py rename to django_dbaccounting/migrations/0007_auto_20200306_2118.py diff --git a/migrations/0008_transaction_updating.py b/django_dbaccounting/migrations/0008_transaction_updating.py similarity index 100% rename from migrations/0008_transaction_updating.py rename to django_dbaccounting/migrations/0008_transaction_updating.py diff --git a/migrations/0009_transaction_edited.py b/django_dbaccounting/migrations/0009_transaction_edited.py similarity index 100% rename from migrations/0009_transaction_edited.py rename to django_dbaccounting/migrations/0009_transaction_edited.py diff --git a/migrations/0010_auto_20200307_1933.py b/django_dbaccounting/migrations/0010_auto_20200307_1933.py similarity index 100% rename from migrations/0010_auto_20200307_1933.py rename to django_dbaccounting/migrations/0010_auto_20200307_1933.py diff --git a/migrations/__init__.py b/django_dbaccounting/migrations/__init__.py similarity index 100% rename from migrations/__init__.py rename to django_dbaccounting/migrations/__init__.py diff --git a/models.py b/django_dbaccounting/models.py similarity index 100% rename from models.py rename to django_dbaccounting/models.py diff --git a/static/css/styles.css b/django_dbaccounting/static/css/styles.css similarity index 100% rename from static/css/styles.css rename to django_dbaccounting/static/css/styles.css diff --git a/templates/base_generic.html b/django_dbaccounting/templates/base_generic.html similarity index 100% rename from templates/base_generic.html rename to django_dbaccounting/templates/base_generic.html diff --git a/templates/dbaccounting/account_confirm_delete.html b/django_dbaccounting/templates/dbaccounting/account_confirm_delete.html similarity index 100% rename from templates/dbaccounting/account_confirm_delete.html rename to django_dbaccounting/templates/dbaccounting/account_confirm_delete.html diff --git a/templates/dbaccounting/account_detail.html b/django_dbaccounting/templates/dbaccounting/account_detail.html similarity index 100% rename from templates/dbaccounting/account_detail.html rename to django_dbaccounting/templates/dbaccounting/account_detail.html diff --git a/templates/dbaccounting/account_form.html b/django_dbaccounting/templates/dbaccounting/account_form.html similarity index 100% rename from templates/dbaccounting/account_form.html rename to django_dbaccounting/templates/dbaccounting/account_form.html diff --git a/templates/dbaccounting/account_list.html b/django_dbaccounting/templates/dbaccounting/account_list.html similarity index 100% rename from templates/dbaccounting/account_list.html rename to django_dbaccounting/templates/dbaccounting/account_list.html diff --git a/templates/dbaccounting/accounttype_confirm_delete.html b/django_dbaccounting/templates/dbaccounting/accounttype_confirm_delete.html similarity index 100% rename from templates/dbaccounting/accounttype_confirm_delete.html rename to django_dbaccounting/templates/dbaccounting/accounttype_confirm_delete.html diff --git a/templates/dbaccounting/accounttype_detail.html b/django_dbaccounting/templates/dbaccounting/accounttype_detail.html similarity index 100% rename from templates/dbaccounting/accounttype_detail.html rename to django_dbaccounting/templates/dbaccounting/accounttype_detail.html diff --git a/templates/dbaccounting/accounttype_form.html b/django_dbaccounting/templates/dbaccounting/accounttype_form.html similarity index 100% rename from templates/dbaccounting/accounttype_form.html rename to django_dbaccounting/templates/dbaccounting/accounttype_form.html diff --git a/templates/dbaccounting/accounttype_list.html b/django_dbaccounting/templates/dbaccounting/accounttype_list.html similarity index 100% rename from templates/dbaccounting/accounttype_list.html rename to django_dbaccounting/templates/dbaccounting/accounttype_list.html diff --git a/templates/dbaccounting/balance_sheet.html b/django_dbaccounting/templates/dbaccounting/balance_sheet.html similarity index 100% rename from templates/dbaccounting/balance_sheet.html rename to django_dbaccounting/templates/dbaccounting/balance_sheet.html diff --git a/templates/dbaccounting/cashflow.html b/django_dbaccounting/templates/dbaccounting/cashflow.html similarity index 100% rename from templates/dbaccounting/cashflow.html rename to django_dbaccounting/templates/dbaccounting/cashflow.html diff --git a/templates/dbaccounting/debt.html b/django_dbaccounting/templates/dbaccounting/debt.html similarity index 100% rename from templates/dbaccounting/debt.html rename to django_dbaccounting/templates/dbaccounting/debt.html diff --git a/templates/dbaccounting/forecast.html b/django_dbaccounting/templates/dbaccounting/forecast.html similarity index 100% rename from templates/dbaccounting/forecast.html rename to django_dbaccounting/templates/dbaccounting/forecast.html diff --git a/templates/dbaccounting/income_statement.html b/django_dbaccounting/templates/dbaccounting/income_statement.html similarity index 100% rename from templates/dbaccounting/income_statement.html rename to django_dbaccounting/templates/dbaccounting/income_statement.html diff --git a/templates/dbaccounting/report.html b/django_dbaccounting/templates/dbaccounting/report.html similarity index 100% rename from templates/dbaccounting/report.html rename to django_dbaccounting/templates/dbaccounting/report.html diff --git a/templates/dbaccounting/retained_earnings.html b/django_dbaccounting/templates/dbaccounting/retained_earnings.html similarity index 100% rename from templates/dbaccounting/retained_earnings.html rename to django_dbaccounting/templates/dbaccounting/retained_earnings.html diff --git a/templates/dbaccounting/transaction_confirm_delete.html b/django_dbaccounting/templates/dbaccounting/transaction_confirm_delete.html similarity index 100% rename from templates/dbaccounting/transaction_confirm_delete.html rename to django_dbaccounting/templates/dbaccounting/transaction_confirm_delete.html diff --git a/templates/dbaccounting/transaction_detail.html b/django_dbaccounting/templates/dbaccounting/transaction_detail.html similarity index 100% rename from templates/dbaccounting/transaction_detail.html rename to django_dbaccounting/templates/dbaccounting/transaction_detail.html diff --git a/templates/dbaccounting/transaction_form.html b/django_dbaccounting/templates/dbaccounting/transaction_form.html similarity index 100% rename from templates/dbaccounting/transaction_form.html rename to django_dbaccounting/templates/dbaccounting/transaction_form.html diff --git a/templates/dbaccounting/transaction_list.html b/django_dbaccounting/templates/dbaccounting/transaction_list.html similarity index 100% rename from templates/dbaccounting/transaction_list.html rename to django_dbaccounting/templates/dbaccounting/transaction_list.html diff --git a/templates/index.html b/django_dbaccounting/templates/index.html similarity index 100% rename from templates/index.html rename to django_dbaccounting/templates/index.html diff --git a/tests/__init__.py b/django_dbaccounting/tests/__init__.py similarity index 100% rename from tests/__init__.py rename to django_dbaccounting/tests/__init__.py diff --git a/tests/test_forms.py b/django_dbaccounting/tests/test_forms.py similarity index 100% rename from tests/test_forms.py rename to django_dbaccounting/tests/test_forms.py diff --git a/tests/test_models.py b/django_dbaccounting/tests/test_models.py similarity index 100% rename from tests/test_models.py rename to django_dbaccounting/tests/test_models.py diff --git a/tests/test_views.py b/django_dbaccounting/tests/test_views.py similarity index 100% rename from tests/test_views.py rename to django_dbaccounting/tests/test_views.py diff --git a/urls.py b/django_dbaccounting/urls.py similarity index 100% rename from urls.py rename to django_dbaccounting/urls.py diff --git a/views.py b/django_dbaccounting/views.py similarity index 100% rename from views.py rename to django_dbaccounting/views.py diff --git a/setup.cfg b/setup.cfg index 1c66a24..6366ad2 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,8 +1,9 @@ [metadata] name = django-dbaccounting -version = 0.1 +version = 0.3 description = A Django app core to perform accounting and transactions. -long_description = file: README.rst +long_description = file: README.md +long_description_content_type = text/markdown url = https://www.robmel.com/ author = Robert Melikyan author_email = robjrm@gmail.com diff --git a/setup.py b/setup.py index 6068493..99d2f76 100644 --- a/setup.py +++ b/setup.py @@ -1,3 +1,13 @@ from setuptools import setup -setup() +# read the contents of the README file +from os import path +this_directory = path.abspath(path.dirname(__file__)) +with open(path.join(this_directory, 'README.md'), encoding='utf-8') as f: + long_description = f.read() + +setup( + name='django_dbaccounting', + long_description=long_description, + long_description_content_type='text/markdown' +)