fourth commit

Author: Fidencio-Codes

LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2016 The Python Packaging Authority (PyPA)
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy of
+    this software and associated documentation files (the "Software"), to deal in
+    the Software without restriction, including without limitation the rights to
+    use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+    of the Software, and to permit persons to whom the Software is furnished to do
+    so, subject to the following conditions:
+    
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+    
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE.

MAINFEST.in

@@ -0,0 +1,4 @@
+include LICENSE.txt
+include README.rst
+recursive-include citylocations/static *
+recursive-include citylocations/templates *

README.rst

@@ -0,0 +1,55 @@
+Django Packaging Exercise 
+
+Will be creating a package in order to install it into an existing Django project
+
+STEPS
+1. Setup the project directory 
+- python -m venv venv
+- . venv/Scripts/activate
+- pip install wheel setuptools twine
+- citylocations.zip
+
+2. Create package configuration files
+- README.rst
+- setup.cfg
+- setup.py
+- MANIFEST.in
+- LICENSE.txt
+
+3. Build package 
+- (bash terminal) python setup.py sdist
+
+4. Install packaged app (on week4 folder)
+- hello_django.zip
+- pip install -r requirements.txt
+- ls ../django_cityloc_pkg/dist
+- pip install ../django_cityloc_pkg/dist/django_cityloc_pkg-0.0.1.tar.gz
+- pip list (to double check pkg installed)
+
+5. Connect new app to project
+- python manage.py runserver 8000
+- Open a browser, and type: http://127.0.0.1:8000 (should see "Hello World")
+- update message and restart app to see new message
+
+
+==============
+City Locations
+==============
+
+City Locations is a Django app that can be installed in an existing Django project
+Documentation: https://toddpy-django-cityloc-pkg.readthedocs.io/en/latest/
+
+Installation
+------------
+
+1. Add "citylocations" to your INSTALLED_APPS setting in settings.py:
+    
+    INSTALLED_APPS = [
+        ...
+        'citylocations',
+    ]
+
+2. Include the citylocations URLconf in your project urls.py like this::
+    path('', include('citylocations.urls')),
+
+3. Start the development server and visit http://127.0.0.1:8000/

docs/.github/workflows/publish_pkg.yaml

@@ -0,0 +1,21 @@
+name: Publish Python Package
+on:
+    release:
+        types: [created]
+jobs:
+    deploy:
+        runs-on: ubuntu-20.04
+        steps:
+        - uses: actions/checkout@v2
+        - uses: actions/setup-python@v2
+        - name: Install dependencies
+          run: |
+            python -m pip install --upgrade pip
+            pip install setuptools wheel twine
+        - name: Build and publish
+          env:
+            TWINE_USERNAME: ${{ secrets.TWINE_USERNAME }}
+            TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }}
+          run: |
+            python setup.py sdist bdist_wheel
+            twine upload --verbose --repository-url https://test.pypi.org/legacy/ -u ${{ secrets.TWINE_USERNAME }} -p ${{ secrets.TWINE_PASSWORD }} dist/*

setup.cfg

@@ -0,0 +1,20 @@
+[metadata]
+    name = django_cityloc_pkg_fidencio-codes
+    version = 0.0.1
+    description = A Django app about city locations
+    author = Author Name
+    author_email = authoremail@example.com
+    classifiers =
+        Environment :: Web Environment
+        Framework :: Django
+        Framework :: Django :: 3.2
+        License :: OSI Approved :: MIT License
+        Operating System :: OS Independent
+        Programming Language :: Python :: 3.9    
+    
+    [options]
+    include_package_data = true
+    packages = find:
+    python_requires = >=3.8
+    install_requires =
+        Django >= 3.2