Refactor package names

Open
#9 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
build-system, cli, tooling

Research direction

Start by inventorying the package and file names containing _new, then inspect setup.py and main.py to trace how packages are currently exposed. Rename the packages under pash_annotations or annotations, rename main.py to an annotation CLI entry point, and update setup.py so users can import the package and install the CLI.

Written by the indexing model from the issue text.

Description

Do a refactoring pass where we change package names (we need to do this in file names and setup.py). Currently, most packages contain _new in the name (which should be removed) and also they should be moved under pash_annotations (or annotations) in the directory, so that users can import them as import pash_annotations.parser instead of import parser_new (which could be a package from an arbitrary library that has nothing to do with PaSh).

Also, we should rename main.py to something like annotation_cli and also include it in the pip package (by adding it to setup.py).

@festutz could you take a stab at those changes in a PR that is targeted to main?

Dominant language
Python
Stars
4
Forks
7
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from binpash/annotations

All issues in binpash/annotations

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.