Agile project artefact generator.
Project description
let-me-render-that-4u (lmrt4u)
Python Package for the lmrt4u agile artefact render tool
Package
Basic structure of package is
├── README.md
├── lmrt4u
│ ├── __init__.py
│ ├── __main__.py
│ ├── controller.py
│ ├── entry.py
│ ├── helpers.py
│ ├── initializer.py
│ ├── interface.py
│ ├── loader.py
│ ├── parser.py
│ ├── renderer.py
│ ├── tuples.py
│ └── validator.py
├── requirements.txt
└── setup.py
Installation
To install the tool without the use of the code repository
pip install lmrt4u-dbneal
Usage
To run the tool do
python -m lmrt4u
This generates a sample Lmrt4ufile in current directory. File can be modified manually then re-run to display updated sprint information.
To run the tool without leveraging to user interface you can pass arguments directly
python -m lmrt4u Burndown Chart
Lmrt4uFile
The Lmrt4uFile contains the backlog information that will be used when the burndown charts are generated. Please note that all sprint properties are enforced through a verification module so make sure to follow the configuration guide below.
Here's a brief example of the file (All information in parenthesis is for the user and should NOT be included in the file):
sprints: (List of sprints contained in the backlog, sample file contains one but you can include as many as you'd like)
Sample Sprint: (This is the name of a sprint)
active: true (A boolean property, if a sprint is active (True) then a burndown chart will be generated)
end: '2019-04-16' (End date for the sprint, *must occur after the start date*, *must match format 'yyyy-MM-DD'*)
start: '2019-04-02' (Start date for the sprint, *must match format 'yyyy-MM-DD'))
stories: (List of arguments with each unique item representing a story)
- - Story Name 1 (This is the name of a story in the sprint)
- This is the description (This is the description for the story)
- 10 (This is the amount of story points assigned to the story)
- '2019-04-03' (This is the completion date, put null if the story is yet to be completed)
Requirements
Package requirements are handled using pip. To install them do
pip install -r requirements.txt
Credits & References
Python module template taken from mtchavez/python-package-boilerplate
SDD template taken from CSUF Course COP3331 Template
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file lmrt4u-dbneal-0.0.3.tar.gz
.
File metadata
- Download URL: lmrt4u-dbneal-0.0.3.tar.gz
- Upload date:
- Size: 5.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
a10a9f1d0d557f3d4b605f7e13ba271e3033daa3ebb26e84239ae67d2ec7f5d5
|
|
MD5 |
09de594b34313889d0c40fb188aee860
|
|
BLAKE2b-256 |
e573f709913897519b1044d6e9b45bef7144cd3a527680b79f2b9ba8724ef027
|
File details
Details for the file lmrt4u_dbneal-0.0.3-py3-none-any.whl
.
File metadata
- Download URL: lmrt4u_dbneal-0.0.3-py3-none-any.whl
- Upload date:
- Size: 9.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
23bf9db7306f9c53f8ea80f9ff4d4533316fe75812dbacf0b91f305bab86e48f
|
|
MD5 |
21808976158adb842889b4e930e98257
|
|
BLAKE2b-256 |
38270c82abcc30990aea04122779bfd626959f5e6fe2cc429459e8a57a2b6298
|