OpenBagTwo / OpenBagTwo/AngerLocalBeehive
Create a python package
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
GIVEN that some of my notebooks contain things I want to run regularly
WHEN I run pip install anger-local-beehive (or poetry install or conda?) into a virtual environment
THEN I have access to command-line utilities that allow me to perform the specific tasks that were prototyped in the notebooks
SO that I don't have to spin up Jupyter and run through a notebook every time I want to do that thing
Some examples:
- Finding a specific mob by species, owner, name or nbt property
- Creating a Creative Mode copy of a world
- Locating unopened loot chests
- Getting the ore composition of chunklets
(TODO: make separate issues for each of these, but they're all blocked by this issue, so...)
Sub-tasks
- create package structure (
pipinstallation is a must-have,poetrywould be sugar) - research options for auto-versioning that wouldn't bump versions on changes to the notebooks (I think I can do this while keeping everything in one repo using worktree)
- set up HTML docs, explicitly to include notebooks (sphinx had a plugin for this, I would be super surprised if mkdocs doesn't have a wrapper for nbconvert as well)
- unit tests (am I going to need to create a testing world?)
- CI via github actions
- onboard to PyPI
- CD via github actions
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the linked notebooks and the package, documentation, testing, GitHub Actions, PyPI, and release sub-tasks. The scope includes turning notebook prototypes into installable command-line utilities, with HTML documentation and automated delivery. Done means the package can be installed and the listed notebook tasks are available through utilities without launching Jupyter.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook, python
- Domain
- build-system, ci-cd, cli, documentation, release, testing
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 22/100