Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename the package from p3 to p3analysis #67

Merged
merged 1 commit into from
Sep 11, 2024

Conversation

Pennycook
Copy link
Contributor

"p3" is already the name of an existing Python package. "p3analysis" was chosen as our replacement name because it is descriptive, and allows for future p3-related packages to follow a similar naming convention.

Related issues

Closes #48.

Proposed changes

  • Replace all instances of "p3" with "p3analysis".

I ran the tests and built the documentation locally, and would appreciate it if reviewers could do the same. Most of these changes were made with mv and/or sed. It looks like git lost track of some of the files as renames depending on how much they changed.

@Pennycook Pennycook added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 4, 2024
@Pennycook Pennycook added this to the 1.0.0 milestone Sep 4, 2024
"p3" is already the name of an existing Python package. "p3analysis" was
chosen as our replacement name because it is descriptive, and allows for
future p3-related packages to follow a similar naming convention.

Signed-off-by: John Pennycook <[email protected]>
Copy link
Contributor

@laserkelvin laserkelvin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally seems good to me; I chalked up a Dockerfile and was able to run stuff without issues:

FROM ghcr.io/astral-sh/uv:0.4.8-python3.12-bookworm

RUN apt-get update -y && apt-get upgrade -y && apt-get install git make
RUN git clone https://github.com/Pennycook/p3-analysis-library.git /opt/p3-analysis-library
WORKDIR /opt/p3-analysis-library
RUN git fetch -a && git checkout package-rename
RUN uv pip install --system -e .
RUN python3 -m unittest discover -s tests
# run some example scripts too
RUN python3 examples/navchart/plot_simple_navchart.py
# try build docs
WORKDIR docs
RUN uv pip install --system sphinx sphinx_gallery furo
RUN make html

As a related thing, pyproject.toml is missing the furo theme dependency under dev!

laserkelvin

This comment was marked as duplicate.

laserkelvin

This comment was marked as duplicate.

@Pennycook Pennycook merged commit b799af1 into intel:main Sep 11, 2024
7 checks passed
@Pennycook Pennycook deleted the package-rename branch September 11, 2024 11:51
Pennycook added a commit that referenced this pull request Oct 18, 2024
- Switches to furo theme (#47)
- Updates examples to new style (#51, #67)
- Adds new examples (#54, #55, #58)
- Marks the documentation unstable (#72)

Signed-off-by: John Pennycook <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Naming conflict with p3 package
2 participants