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.
1 maintainer
Metadata
1 maintainer
Release files for bookshelf-cli 0.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| bookshelf-cli-0.4.0.tar.gz | 12.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| bookshelf_cli-0.4.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 27.3 kB
Release files / bookshelf-cli-0.4.0.tar.gz
| Download URL | bookshelf-cli-0.4.0.tar.gz |
|---|---|
| Size | 12.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5f4e1e9f523f76bb0aa622b8f1257290b55252fcc3067c4de4afa8abf191365f
|
|
BLAKE2b-256 checksum How to use checksums |
2fcd387b424d811fa22cf9ec84b4083169095c9ab7a6af7d3c647528ec3ee12b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/4.0.2 CPython/3.11.6
|
Release files / bookshelf_cli-0.4.0-py3-none-any.whl
| Download URL | bookshelf_cli-0.4.0-py3-none-any.whl |
|---|---|
| Size | 15.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
07eecbe5d71228b82a6f2f369fe171cde3ac949795d76717f26e4359e42ba8b1
|
|
BLAKE2b-256 checksum How to use checksums |
c77411c11c1c0e8d697475161af0c6a648a2b20b859b88f1a9518987d29e6755
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/4.0.2 CPython/3.11.6
|
