PSU-Base
Reusable Django app specifically for PSU's custom-built web applications.
It encapsulates the common functionality that we would otherwise need to program into each application we build.
Features include:
- PSU Single Sign-On (SSO)
- Authentication and authorization features
- Feature toggles
- Template tags for our static content server
Quick Start
Dependencies
The following dependencies may be REQUIRED in your system:
libpq-devsudo apt install libpq-dev
Start a PSU Base Enabled Project
django-admin.py startproject \
--template=*some-path-to*/psu-base-template.zip \
--extension=py,md,env \
my_project_name
Configuring Your App
After starting a new project from the custom template (above):
cd my_project_namepip install -r requirements.txt- Review/Update the application metadata in settings.py
- Run migrations:
python manage.py migrate
If you have the PSU Secret Key file, your site was configured to access Finti's test server. This will need to be overwritten in local_settings.py eventually. If you do not have the PSU Secret Key file, you'll need to set these prior to running your app.
Usage
Usage of the psu-base app is documented in Confluence.
For Developers
The version number must be updated for every PyPi release.
The version number is in psu_base/__init__.py
Document Changes
Record every change in docs/CHANGELOG.txt Document new features or significant changes to existing features in Confluence.
Publishing to PyPi
- Create accounts on PyPi and Test PyPi
- Create
~/.pypirc[distutils] index-servers= pypi testpypi [testpypi] repository: https://test.pypi.org/legacy/ username: mikegostomski password: pa$$w0rd [pypi] username: mikegostomski password: pa$$w0rd - Ask an existing developer to add you as a collaborator - test and/or prod
python setup.py sdist bdist_wheel --universaltwine upload --repository testpypi dist/*twine upload dist/*- Tag the release in Git. Don't forget to push the tag! Example:
git tag 0.1.2
git push origin 0.1.2
1 maintainer
Release files for psu-base 0.10.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| psu_base-0.10.4-py3-none-any.whl | Python 3 | none | any | Details |
Release files / psu_base-0.10.4-py3-none-any.whl
| Download URL | psu_base-0.10.4-py3-none-any.whl |
|---|---|
| Size | 122.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4744ff56bcc753cc7518ea05c80228ba6515a04c05686945a8fe8e3264e03f8d
|
|
BLAKE2b-256 checksum How to use checksums |
52c8b3f81b0c24cff4ed7d2fa7786aba5c69a52fa9990c51bfb874f2c00e158e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.8.10
|
