Majic Projects
previous_open_issue.png
Go to the previous open issue
previous_issue.png
Go to the previous issue (open or closed)
star_faded.png
Please log in to bookmark issues
task_small.png
Closed Task CONNT-28 Clean-up existing code and documentation to make the project usable/installable
next_issue.png
Go to the next issue (open or closed)
next_open_issue.png
Go to the next open issue
icon_info.png This issue has been closed with status "Closed" and resolution "RESOLVED".
Issue basics
  • Type of issue
    Task
  • Category
    Not determined
  • Targetted for
    0.3
  • Status
    Closed
  • Progress
  • Priority
    Not determined
User pain
  • Type of bug
    Not triaged
  • Likelihood
    Not triaged
  • Effect
    Not triaged
Affected by this issue (0)
There are no items
People involved
Times and dates
  • Posted at
  • Last updated
  • Estimated time
    2 hours
  • Time spent
    No time spent
    Click here to see time logged against this issue
Issue details
  • Resolution
    RESOLVED
Attachments (0)
There is nothing attached to this issue
Commits (0)
There are no code checkins for this issue
Duplicate issues (0)
This issue does not have any duplicates
Description

Since the project has been written long time ago and has not really been maintained, it is heavily outdated, and rather unlikely to be functioning when installed.

Prior to investing more time into upgrading various components, it would be beneficial to clean-up the existing base, and make it fully usable and installable with the existing code and outdated dependencies.

The following should be done:

  • Update documentation:

    • Introduce a development section, covering:

      • Set-up of development environment.
      • Running the application via test/development project.
      • Running tests.
      • How to update the existing development requirements.txt file via pip-tools.
    • State supported Django version in the documentation for installation purposes.
    • Update installation quick-start instructions to use regular pip package installation
      via PyPI (instead of from repository).
    • Deduplicate documentation in README file.
    • Ensure RTD documentation is building properly.
  • Update requirements handling for both development and installation purposes:

    • Update package requirement resolution to use statically configured requirements section (no pip internals magic).
    • Ensure project depends on correct (old) versions of Django and other packages.
    • Introduce use of pip-tools for keeping development requirements file in sync.
    • Remove test requirements from setup.py.
  • Rename projtest directory to testproject, ensuring to update any references in documentation to it.
  • Make sure source distribution can be built without warnings.
  • Mirror the project on Bitbucket, updating links for where the source can be downloaded from.
Comments ()
There are no comments
History