https://github.com/yurireeis/bddocs
Create end-user readable docs in Pythonic way
https://github.com/yurireeis/bddocs
bdd bdd-style bddocs bdds charts documentation end-user pythonic readable
Last synced: 2 months ago
JSON representation
Create end-user readable docs in Pythonic way
- Host: GitHub
- URL: https://github.com/yurireeis/bddocs
- Owner: yurireeis
- License: mit
- Created: 2017-04-11T19:17:32.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-04-24T01:58:14.000Z (almost 9 years ago)
- Last Synced: 2025-10-25T23:42:16.586Z (5 months ago)
- Topics: bdd, bdd-style, bddocs, bdds, charts, documentation, end-user, pythonic, readable
- Language: Python
- Size: 68.4 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Bddocs
EN: Create end-user readable docs in Pythonic way
PT: Crie documentos legíveis para o usuário final de forma Pythonica
## Installation
To install Bddocs, simply:
```bash
$ pip install bddocs
✨🍰✨
```
Satisfaction, guaranteed.
## How to start ##
To use, simply:
```python
>>> from bddocs import Documentation # to retrieve bdd information
>>> from bddocs import PDF # to get PDF output
>>> from bddocs import HTML # to get it HTML output
>>> bdd = Document('example') # pass the path of .feature documents
>>> PDF(bdd).output('document.pdf') # retrieve BDD info in a PDF file
>>> HTML(bdd).output('document.html') # retrieve BDD info in a HTML file
```
## Documentation
[We are still documenting](https://github.com/yurireeis/bddocs/issues/14).
## How to Contribute
Before opening any issues or proposing any pull requests, please read our
[Contributor's Guide](CONTRIBUTING.md).