write-me
Description
Version: 0.6
Python package to assist developers by generating a README.md file based on a repository.
- Elegant, automatic Markdown formatting
- Commandline options for Django, Pyramid, and Flask
- Installation, testing, and local serving instructions based on codebase
Authors
Dependencies
- markdown_generator
Documentation
Additional documentation can be found on our Read the Docs site.
Getting Started
Prerequisites
Installation
First, clone the project repo from Github. Then, change directories into the cloned repository. To accomplish this, execute these commands:
$ git clone https://github.com/chelseadole/write-me.git
$ cd write-me
Now now that you have cloned your repo and changed directories into the project, create a virtual environment named "ENV", and install the project requirements into your VE.
$ python3 -m venv ENV
$ source ENV/bin/activate
$ pip install -r requirements.txt
Test Suite
Running Tests
This application uses pytest as a testing suite. To run tests, run:
$ pytest
To view test coverage, run:
$ pytest --cov
Test Files
The testing files for this project are:
| File Name | Description |
|---|---|
./test_dep_info.py |
Test dep_info module. |
./readme_generator/test_scaffold.py |
|
./write_me/conftest.py |
|
./write_me/test_django_setings_info.py |
Test django settings module. |
./write_me/test_list_files.py |
Test for files listed. |
./write_me/test_project_data.py |
Test project data module. |
./write_me/test_pyramid_ini.py |
Test pyramid_ini file module. |
./write_me/test_scaffold.py |
|
./write_me/test_stp_info.py |
Test the setup.py parsing function. |
./write_me/test_travis_badge.py |
Test travis badge. |
./write_me/test_tsting_info.py |
Test test info dict. |
./write_me/test_uri_info.py |
Test url and route dictionary. |
./write_me/test/test_scaffold.py |
Tests for scaffold of README generator. |
Development Tools
- python - programming language
License
This project is licensed under MIT License - see the LICENSE.md file for details.
Acknowledgements
- Coffee
This README was generated using writeme.
