From c4eff35ea5e0090b64d65eb6bbe36dc3456c6563 Mon Sep 17 00:00:00 2001 From: heinzel Date: Sun, 17 Nov 2019 14:01:09 +0100 Subject: [PATCH] UPD: Improved metadata and documentation. --- LICENSE | 2 ++ README.rst | 29 +++++++++++++++++++++++------ setup.py | 27 +++++++++++++++++++++++---- tox.ini | 1 + 4 files changed, 49 insertions(+), 10 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f76bc03 --- /dev/null +++ b/LICENSE @@ -0,0 +1,2 @@ +Permission to use, copy, modify, and/or distribute this software +for any purpose with or without fee is hereby granted. diff --git a/README.rst b/README.rst index 889d05d..c1a5d2d 100644 --- a/README.rst +++ b/README.rst @@ -1,19 +1,36 @@ ABOUT ===== -This is a helper to deploy django apps. +This is a helper to deploy reusable django apps +into a django project. REQUIREMENTS ============ -See INSTALL.rst +- python >= 2.7 +- Django + (will be pulled in by pip, if you haven't installed it already. + Probably this is why you are interested in this project) INSTALLATION ============ -See INSTALL.rst +``pip install .`` -LICENCE +USAGE +===== +``django-deploy.py --help`` + + +DEVELOPMENT +=========== +For running the test suite, you will need tox +(or pytest and mock). + +Running the test suite: + ``tox`` + + +LICENSE ======= -Permission to use, copy, modify, and/or distribute this software -for any purpose with or without fee is hereby granted. +See LICENSE diff --git a/setup.py b/setup.py index f17ec90..14ddd0f 100644 --- a/setup.py +++ b/setup.py @@ -6,6 +6,13 @@ from setuptools import setup, find_packages from setuptools import Command +def long_description(): + path = os.path.abspath(os.path.dirname(__file__)) + file = os.path.join(path, 'README.rst') + with open(file) as f: + return f.read() + + class MyCommand(Command): user_options = [] @@ -61,10 +68,22 @@ class CreatePythonEnvironment(MyCommand): setup( name='django-deploy', version='0.2.dev0', - description='Helper to deploy django apps.', + description='A helper to deploy reusable django apps into a django project.', + long_description=long_description(), + long_description_content_type='text/x-rst', url='https://dev.heinzelwerk.de/git/python/django-deploy', - maintainer='Jens Kleineheismann', - maintainer_email='heinzel@farbemachtstark.de', + author='Jens Kleineheismann', + author_email='heinzel@farbemachtstark.de', + classifiers=[ + 'Development Status :: 3 - Alpha', + 'Environment :: Console', + 'Framework :: Django', + 'Intended Audience :: Developers', + 'Intended Audience :: System Administrators', + 'License :: Public Domain', + 'Operating System :: OS Independent', + 'Programming Language :: Python', + ], cmdclass={ 'python': CreatePythonEnvironment, }, @@ -76,8 +95,8 @@ setup( 'django-deploy.py = django_deploy:main', ], }, + python_requires='>=2.7', install_requires=[ 'django', - 'mock', ], ) diff --git a/tox.ini b/tox.ini index 90de704..6d7cb75 100644 --- a/tox.ini +++ b/tox.ini @@ -6,6 +6,7 @@ deps = coverage py2: pylint-django<2 py3: pylint-django pytest + mock commands = coverage run -m pytest coverage report --skip-covered --fail-under=98 pylint django_deploy