Majic Projects
Gimmecert
Go to the previous open issue
Go to the previous issue (open or closed)
star_faded.png
Please log in to bookmark issues
icon_project.png Gimmecert / Closed Feature request GC-2 Project skeleton
action_vote_minus_faded.png
0
Votes
action_vote_plus_faded.png
Go to the next issue (open or closed)
Go to the next open issue
This issue has been closed with status "Closed" and resolution "RESOLVED".
Issue basics
  • Type of issue
    Feature request
  • Category
    Not determined
  • Targetted for
    0.1.0
  • 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
    4 hours
    Click here to see time logged against this issue
Issue details
  • Resolution
    RESOLVED
Attachments (0)
There is nothing attached to this issue
Duplicate issues (0)
This issue does not have any duplicates
Description

Implement initial project skeleton.

The following should be done:

  • Project should be released either under BSD or GPLv3 + CC-BY-SA-3.0 (code + documentation) license. It might be better to go for GPLv3 + CC-BY-SA-3.0 since it's not a library.
  • Ensure that all files have proper licensing headers at top.
  • Add relevant license files.
  • A dummy project directory should be created with __init__.py within.
  • A dummy tests and functional_tests directories should be created with __init__.py within.
  • Add initial documentation using Sphinx:
    • Include README.rst at top-level directory with basic information about the project:
      • About Gimmecert section. Ensure to list compatibility (Python 3.4+).
      • Why was this applicaiton created section.
      • Features section (placeholder for now).
      • License section, mentioning the license for code and docs.
    • Include basic instructions for development:
      • Setting-up environment.
      • Running tests (via tox - including docs - and directly).
  • Create Python package configuration (setup.py and MANIFEST.in):
    • Ensure to add additional extras flags, like test, testlint, devel, and doc.
    • Ensure to include tox, pytest, pytest-cov, pytest-flake8,flake8, andsphinx` in requirements.
    • Make sure pytest is used for running tests.
    • Dependency should be implemented using the extras flags for tests and development.
    • Look at Django Wiki for inspiration on extras and using pytest as default test-runner.
    • Ensure project is marked for use with Python 3/3.4+.
  • Create coverage configuration:
    • Coverage reports should be generated by default in html format.
    • Coverage reports should be stored in directory coverage.
    • Ensure that coverage is applied by default against just the project module.
  • Create tox configuration:
    • Environments for running tests under Python 3.4, 3.5, and 3.6, as default targets.
    • Environment for running lint tests under Python 3, as default target.
    • Environment for test documentation building under Python 3, as default target.
  • Create flake8 configuration:
    • Increase maximum line length to 160.
  • Create initial .gitignore, making sure to:
    • Ignore build artefacts.
    • Ignore temporary files.
    • Ignore test artefacts.
Todos (0 / 0)
There are no comments