diff --git a/Readme.md b/Readme.md index 4a4a90c..48f0ba6 100644 --- a/Readme.md +++ b/Readme.md @@ -22,7 +22,7 @@ Right now it depends on the following non-core Python 3 libraries. These can be * [django-widget-tweaks](https://github.com/jazzband/django-widget-tweaks) Tweak the form field rendering in templates, not in python-level form definitions. * [django-taggit](https://github.com/jazzband/django-taggit) A simpler approach to tagging with Django. - ### Bundled Dependencies +### Bundled Dependencies We also leverage some other great OpenSource projects' code. We bundle those in the distribution to obsolete the need to pull those files from monitored CDNs. * [OpenLayers](https://openlayers.org/) [6.4.3] OpenLayers makes it easy to put a dynamic map in any web page. It can display map tiles, vector data and markers loaded from any source. @@ -88,7 +88,9 @@ Run `django_lostplaces/managy.py collectstatic` and you should be ready to go. If you haven't already setup a django instance, see [django's documentation](https://docs.djangoproject.com/en/3.1/topics/install/). -After that, download the desired release (probably the latest one) [from the releases page](https://git.mowoe.com/reverend/lostplaces-backend/releases) and install it using `pip install --user name-of-the-file.tar.gz` +Afterwards, either +- download the desired release [from the releases page](https://git.mowoe.com/reverend/lostplaces-backend/releases) and install it using `pip install --user name-of-the-file.tar.gz` +- or install the latest release using `pip install django-lostplaces` *Note: You can run pip install without the --user flag, which will require root privileges and introduces potential security issues.* @@ -144,3 +146,7 @@ Before making the django instance public, you should tweak the config `settings. Run `django_lostplaces/manage.py collectstatic` you should be ready to go. + + +### Contact +If you run into any issues, have any questions or If you are interested in this project in general, feel free to get in touch with us via [reverend@reverend2048.de](mailto:reverend@reverend2048.de), we do speak English and German. \ No newline at end of file diff --git a/MANIFEST.in b/django_lostplaces/MANIFEST.in similarity index 64% rename from MANIFEST.in rename to django_lostplaces/MANIFEST.in index f888311..69159df 100644 --- a/MANIFEST.in +++ b/django_lostplaces/MANIFEST.in @@ -1,3 +1,4 @@ +exclude include LICENSE include Readme.rst include Pipfile diff --git a/django_lostplaces/setup.cfg b/django_lostplaces/setup.cfg deleted file mode 100644 index 97ab993..0000000 --- a/django_lostplaces/setup.cfg +++ /dev/null @@ -1,8 +0,0 @@ -# Config options for coverage -# Docs: https://coverage.readthedocs.io/en/latest/config.html - -[coverage:run] -source = . - -[coverage:report] -show_missing = True diff --git a/setup.py b/django_lostplaces/setup.py old mode 100644 new mode 100755 similarity index 83% rename from setup.py rename to django_lostplaces/setup.py index c8e8ed8..41d13f4 --- a/setup.py +++ b/django_lostplaces/setup.py @@ -1,9 +1,9 @@ -#!/usr/bin/env python +#!/usr/bin/env python3 # -*- coding: utf-8 -*- from setuptools import setup, find_packages -with open('Readme.md') as f: +with open('../Readme.md') as f: readme = f.read() setup( @@ -13,7 +13,7 @@ setup( author='Reverend', author_email='reverend@reverend2048.de', url='https://git.mowoe.com/reverend/lostplaces-backend', - packages=find_packages(exclude=['lostplaces']), + packages=find_packages(exclude=['django_lostplaces']), long_description=readme, long_description_content_type='text/markdown', classifiers=[ @@ -31,5 +31,6 @@ setup( 'django-widget-tweaks', 'django-taggit' ], - include_package_data=True + include_package_data=True, + license='MIT' )