📚 A CLI tool for tracking your stories in the SDLC.
Project description
bookshelf
📚 A CLI tool for tracking your stories in the software development lifecycle
🔎 Tracking your productivity has never been easier
🚀 Getting Started
🛠️ Installation
Use pip
to install bookshelf:
pip install bookshelf
To optimally set up bookshelf, follow the Getting Started guide in the documentation.
🧑💻 Usage
The documentation for bookshelf is available at bookshelf.docs.joss.dev and contains a detailed guide on how to use bookshelf.
To list available commands, either run bookshelf
with no parameters or execute bookshelf
help:
The base command for the bookshelf
CLI.
Subcommands
Name | Description |
---|---|
cancel | Cancel the current chapter of a story on your bookshelf |
create | Create a new story for your bookshelf |
finish | Finish writing a story on your bookshelf |
info | Displays the information for a given story on your bookshelf |
ls | List all the current stories on your bookshelf |
rm | Remove a story from your bookshelf |
start | Start a new chapter for a story on your bookshelf |
stop | Stop the current chapter of a story on your bookshelf |
tag | Add a new tag a story on your bookshelf |
untag | Remove a tag from a story on your bookshelf |
🤝 Contributing
We're excited that you want to contribute to bookshelf. Your help and contributions are greatly appreciated! Read the contribution guidelines to get started.
📜 Code of Conduct
We value your contribution and participation in our community. To ensure a positive and inclusive environment for all, we have established a Code of Conduct. Read the Code of Conduct to learn more.
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
Hashes for bookshelf_cli-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 07eecbe5d71228b82a6f2f369fe171cde3ac949795d76717f26e4359e42ba8b1 |
|
MD5 | a6435e7aa7a085dcf02a04d5604e3ff1 |
|
BLAKE2b-256 | c77411c11c1c0e8d697475161af0c6a648a2b20b859b88f1a9518987d29e6755 |