A pirate-themed ledger for crew members and sea notes.
Project description
Pirate Ledger
Arrr, welcome to Pirate Ledger - the captain's logbook for managing your crew and sea notes!
Introduction
Pirate Ledger is a Python module designed to keep track of your pirate crew members and their details, along with any sea notes that you might need to jot down during your adventures on the high seas.
Features
- Crew Roster: Manage your crew members, including adding, updating, and deleting records.
- Sea Notes: Keep detailed notes with easy searching capabilities.
- Pirate-themed Experience: Enjoy a fully immersive pirate experience while managing your records.
Development
Start local - python -m pirate_ledger.main
To work on the Pirate Ledger and push new versions to PyPI, follow these steps:
-
Update the Version Before pushing a new version, ensure you update the version number in the
setup.py
file. This is crucial for PyPI to recognize the new version. For example:version='1.0.1'
-
New build python setup.py sdist bdist_wheel
-
Upload to PyPI pip install twine twine upload dist/*
Commands
Inside the assistant bot, you can use the following commands:
crew:add
- Add a new crew member.crew:show
- Show a specific crew member's details.crew:all
- Display all crew members.crew:birthdays
- Show upcoming birthdays of crew members.crew:update
- Update a crew member's details.crew:delete
- Walk the plank (delete) a crew member.crew:search
- Search for crew members by name or details.note:add
- Add a new sea note.note:delete
- Delete a sea note.note:update
- Update a sea note.note:all
- Show all sea notes.note:search
- Search for sea notes by title or content.
License
This project is licensed under the MIT License. See the LICENSE file for more details.
Installation
To install the Pirate Ledger module, use the following command:
pip install pirate-ledger
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 pirate_ledger-1.0.0.tar.gz
.
File metadata
- Download URL: pirate_ledger-1.0.0.tar.gz
- Upload date:
- Size: 8.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 97740bb0bf46298aea4999800382fc42fb052d2ca96bb6a8abc32b750c486be9 |
|
MD5 | 06f3721ebc62ce9177250e7fb2a7838e |
|
BLAKE2b-256 | 5030573bdca164734bebc06480b7834340ae2795f170cd928321934fcd40484b |
File details
Details for the file pirate_ledger-1.0.0-py3-none-any.whl
.
File metadata
- Download URL: pirate_ledger-1.0.0-py3-none-any.whl
- Upload date:
- Size: 10.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3cd72aa635ceac9b3f356cce7755ad37b3890204c788e56b97d0b848603ee05d |
|
MD5 | 4de379d6a406187b9e94b7e2eb911dc0 |
|
BLAKE2b-256 | 6661981d033b8397d2b8214f82b789c19f734344205a2fe97c0fa2a492bad1ba |