Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Proplan

Django application to assign a tasks, defining bugs and planning of your project.

Installation

pip3 install django-proplan

Quick start

  1. Add “proplan” to your INSTALLED_APPS setting like this:

INSTALLED_APPS = [
    ...
    'proplan',
]
  1. Include the polls URLconf in your project urls.py like this:

path('plan/', include('proplan.urls')),
  1. Run python3 manage.py migrate to create the Proplan models.

  2. Run python3 manage.py createsuperuser to create the user if you don’t have one.

  3. Start the development server and visit http://127.0.0.1:8000/admin/ to login (you’ll need the Admin app enabled).

  4. Visit http://127.0.0.1:8000/plan/ to create your plan of work on project.

Automatic Bug System

The Proplan allows you to enable automatic publication of errors that have occurred in the project through ABS - Automatic Bug System. There are 2 ways to do this:

  1. Logging errors directly to server.

  2. Sending errors through API.

Logging errors

Connect “proplan.log.ABSHandler” to your LOGGING setting like this:

LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    ...
    'handlers': {
        ...
        'abs': {
            'class': 'proplan.log.ABSHandler',
            'level': 'ERROR',
        }
    },
    'loggers': {
        ...
        'django': {
            'handlers': ['abs'],
            'level': 'ERROR',
        },
    },
}

Sending errors

  1. Add “ABS_KEY” to your PROPLAN setting like this:

PROPLAN = {
    ...
    'ABS_KEY': 'cookie-supported-key',
}
  1. Make POST response with data of bug to API:

curl -H 'Cookie: proplanabs=cookie-supported-key' \
--data-urlencode 'title=Bug in mobile app&message=More...' \
http://127.0.0.1:8000/plan/abs/create/

Settings

All next settings must be within the dictionary PROPLAN, when you define them in the file settings.py

ACCESS_FUNCTION

Function that checks access to resources. You may want to use:

  1. proplan.access.authenticated - for authenticated users.

  2. proplan.access.staff - for employers and superusers.

  3. proplan.access.superuser - for superusers only.

  4. proplan.access.view_thread - for users with view permission for Thread model.

  5. any custom function.

The default is the internal function proplan.access.view_thread.

ABS_KEY

The options for Automatic Bug System. While there is no key, the system does not work. By default no key.

ATTACH_UPLOAD_PATH

Path to uploading files. By default is:

'proplan/attaches/%(date)s/%(code)s/%(filename)s'

ATTACH_THUMB_SIZE

The size of the thumbnails for attached images. By default is:

(300, 300)

ATTACH_THUMB_EXTENSIONS

List of recognized image extensions to be previewed. By default is:

['.png', '.jpg', '.jpeg', '.bmp']

PRIORITIES

List of recognized image extensions to be previewed. By default is:

[
    (1, _('low')),
    (2, _('normal')),
    (3, _('high')),
    (4, _('urgent')),
    (5, _('immediate')),
]

Metadata

Release files for django-proplan 0.0.1.dev20190419055027

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for django-proplan 0.0.1.dev20190419055027
File Size Uploaded Provenance
django-proplan-0.0.1.dev20190419055027.tar.gz 1.3 MB Without provenance Details

Release files / django-proplan-0.0.1.dev20190419055027.tar.gz

Download URL django-proplan-0.0.1.dev20190419055027.tar.gz
Size 1.3 MB
Tags Source
SHA-256 checksum
How to use checksums
7c49f7061ad3b3c678648c488b0f331b43c6b408249bef4a8550321237e655c7
BLAKE2b-256 checksum
How to use checksums
2ac8e98ed9dfe3f10452294c01726e37907ae8a62a1237f03d120261b7c6ecdc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via Python-urllib/3.5

Security for django-proplan 0.0.1.dev20190419055027

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page