pypi release prep!

russellballestrini commented

2025-03-02 08:37:41 -05:00

(Migrated from git2.unturf.com)

modified: .gitlab-ci.yml
modified: Makefile
modified: README.rst
modified: setup.py

Summary by CodeRabbit

New Features
- Introduced a new CI/CD stage for packaging and uploading Python distributions to PyPI.
- Enhanced commands for flexible installation, environment setup, and server operation.
Documentation
- Revised guides with clear, step-by-step instructions for installation, virtual environment activation, and starting the server.
Chores
- Upgraded the automated release process for packaging and distributing the project.
- Streamlined dependency management and broadened support for additional Python versions.

modified: .gitlab-ci.yml modified: Makefile modified: README.rst modified: setup.py  ## Summary by CodeRabbit - **New Features** - Introduced a new CI/CD stage for packaging and uploading Python distributions to PyPI. - Enhanced commands for flexible installation, environment setup, and server operation. - **Documentation** - Revised guides with clear, step-by-step instructions for installation, virtual environment activation, and starting the server. - **Chores** - Upgraded the automated release process for packaging and distributing the project. - Streamlined dependency management and broadened support for additional Python versions.

coderabbitai commented

2025-03-02 08:37:49 -05:00

(Migrated from git2.unturf.com)

Walkthrough

This pull request updates multiple core components. In the CI/CD pipeline, a new pypi-twine stage is introduced to build and upload Python distributions to PyPI, with adjustments to job trigger conditions across stages. The Makefile has been restructured to replace removed targets with modular, new ones handling virtual environments, configurations, and various installation modes. The README documentation has been revised for clearer, step-by-step installation guidance, and setup.py now includes a function to parse requirement files and enhanced dependency definitions.

Changes

File(s)	Change Summary
`.gitlab-ci.yml`	Added new `pypi-twine` stage/job for packaging & uploading to PyPI; modified `test`, `build`, and `deploy` stages (updated command from `make prod` to `make install-from-source-prod`, adjusted branch/tag rules, rephrased comments).
`Makefile`	Restructured targets: removed `env`, `dev`, `prod`, `init_db`; added targets such as `all`, `venv`, `config`, `install-core`, `install-dev`, `install`, `install-source-dev-and-test`, `install-source-prod`, `init-db`, `serve`, `install-from-pypi`, `install-from-source`, `activate`, `test`, and `http`; updated `clean` target.
`README.rst`	Revised documentation structure and content; introduced a clearer quick start guide with distinct PyPI, source (editable), and production (non-editable) installation instructions, including virtual environment activation details and updated navigation hints.
`setup.py`	Introduced `parse_requirements` to read requirements files; updated `install_requires`, `extras_require` (adding keys “dev”, “prod”, “test”), and long description handling; expanded Python classifiers and included all packages.

Sequence Diagram(s)

sequenceDiagram
  participant Dev as Developer
  participant CI as GitLab CI
  participant PT as pypi-twine Job
  participant PyPI as PyPI Repository

  Dev->>CI: Push commit (tag or branch)
  CI->>CI: Run test & build stages (skipped on tag events)
  alt Tag Event
    CI->>PT: Trigger pypi-twine stage
    PT->>PT: Upgrade pip, install twine, build distributions
    PT->>PyPI: Upload package
  else Branch Event
    CI->>CI: Execute deploy stage for main, develop, master
  end

engineering/make-post-sell/make_post_sell#37: Updates similar deployment rules in .gitlab-ci.yml, directly relating to the modifications in deployment job triggers.

Poem

I’m a code rabbit, hopping with cheer,
New stages and targets now bright and clear.
CI pipelines dance to a pypi tune,
Makefiles sing under a modular moon.
Documentation blossoms, setup refined,
In every line, sweet structure aligned.
A joyful leap in code—let’s celebrate! 🐇✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

## Walkthrough This pull request updates multiple core components. In the CI/CD pipeline, a new `pypi-twine` stage is introduced to build and upload Python distributions to PyPI, with adjustments to job trigger conditions across stages. The Makefile has been restructured to replace removed targets with modular, new ones handling virtual environments, configurations, and various installation modes. The README documentation has been revised for clearer, step-by-step installation guidance, and `setup.py` now includes a function to parse requirement files and enhanced dependency definitions. ## Changes | File(s) | Change Summary | |-------------------------|----------------| | `.gitlab-ci.yml` | Added new `pypi-twine` stage/job for packaging & uploading to PyPI; modified `test`, `build`, and `deploy` stages (updated command from `make prod` to `make install-from-source-prod`, adjusted branch/tag rules, rephrased comments). | | `Makefile` | Restructured targets: removed `env`, `dev`, `prod`, `init_db`; added targets such as `all`, `venv`, `config`, `install-core`, `install-dev`, `install`, `install-source-dev-and-test`, `install-source-prod`, `init-db`, `serve`, `install-from-pypi`, `install-from-source`, `activate`, `test`, and `http`; updated `clean` target. | | `README.rst` | Revised documentation structure and content; introduced a clearer quick start guide with distinct PyPI, source (editable), and production (non-editable) installation instructions, including virtual environment activation details and updated navigation hints. | | `setup.py` | Introduced `parse_requirements` to read requirements files; updated `install_requires`, `extras_require` (adding keys “dev”, “prod”, “test”), and long description handling; expanded Python classifiers and included all packages. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant Dev as Developer participant CI as GitLab CI participant PT as pypi-twine Job participant PyPI as PyPI Repository Dev->>CI: Push commit (tag or branch) CI->>CI: Run test & build stages (skipped on tag events) alt Tag Event CI->>PT: Trigger pypi-twine stage PT->>PT: Upgrade pip, install twine, build distributions PT->>PyPI: Upload package else Branch Event CI->>CI: Execute deploy stage for main, develop, master end ``` ## Possibly related PRs - **engineering/make-post-sell/make_post_sell#37**: Updates similar deployment rules in `.gitlab-ci.yml`, directly relating to the modifications in deployment job triggers. ## Poem > I’m a code rabbit, hopping with cheer, > New stages and targets now bright and clear. > CI pipelines dance to a pypi tune, > Makefiles sing under a modular moon. > Documentation blossoms, setup refined, > In every line, sweet structure aligned. > A joyful leap in code—let’s celebrate! 🐇✨      --- Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? <details> <summary>❤️ Share</summary> - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code) </details> <details> <summary>🪧 Tips</summary> ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit <commit_id>, please review it.` - `Generate unit testing code for this file.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai generate docstrings` to [generate docstrings](https://docs.coderabbit.ai/finishing-touches/docstrings) for this PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements. </details>

coderabbitai commented

2025-03-02 08:39:26 -05:00

(Migrated from git2.unturf.com)

changed the description

coderabbitai commented

2025-03-02 08:42:11 -05:00

(Migrated from git2.unturf.com)

Actionable comments posted: 2

🧹 Nitpick comments (2)

README.rst (1)
50-50: Fix Markdown link in RST document.

You're using Markdown link syntax in a reStructuredText file, which won't render correctly.
-   Then browse to [http://127.0.0.1:6501/](http://127.0.0.1:6501/) to view the app.
+   Then browse to `http://127.0.0.1:6501/ <http://127.0.0.1:6501/>`_ to view the app.
Makefile (1)
112-114: Test target dependency is suboptimal.

The test target depends on install-source-dev-and-test, which always copies the virtual environment even when just running tests. This could slow down test runs.
-test: install-source-dev-and-test
+test: venv
 	@echo "Running tests..."
 	$(VENV_DIR)/bin/py.test
Then add a separate target for installing and testing:
# Install and run tests
install-and-test: install-source-dev-and-test test

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 29e8d9a503 and 79aa2ddd6c.

📒 Files selected for processing (4)

.gitlab-ci.yml (3 hunks)
Makefile (1 hunks)
README.rst (1 hunks)
setup.py (1 hunks)

🔇 Additional comments (12)

.gitlab-ci.yml (4)

5-5: LGTM: The new pypi-twine stage is a logical addition.

A dedicated stage for PyPI deployment is good practice.

10-11: LGTM: Skipping test/build on tags is appropriate.

This correctly prevents redundant jobs from running on tags since they're intended for releases.

Also applies to: 21-22

25-25: LGTM: Updated build script to use new Makefile target.

This aligns with the renamed target in the Makefile.

52-52: LGTM: Adding 'main' to deployment branches.

Good update to include 'main' as many projects have migrated from 'master' to 'main'.

setup.py (3)

4-11: LGTM: Well-structured requirement parsing function.

The function correctly handles ignoring comments and blank lines, making it robust for parsing requirement files.

13-21: LGTM: Clean separation of dependencies.

Good organization of requirements into runtime, development, production, and testing categories.

69-70: LGTM: Helpful reminder comments.

These commands serve as a good reminder for package building and uploading.

README.rst (1)

18-48: LGTM: Well-structured installation instructions.

The step-by-step approach with multiple installation options is clear and matches the Makefile targets perfectly.

Makefile (4)

3-15: LGTM: Excellent variable definitions.

Defining these variables at the top makes the Makefile more maintainable and easier to modify.

16-17: LGTM: Good default target.

Having a default target that performs the most common workflow is user-friendly.

24-36: LGTM: Smart use of file prerequisites.

Using file paths as prerequisites is an elegant way to avoid redundant operations.

93-100: LGTM: Great combined setup targets.

These targets provide a clear, consistent interface for different installation scenarios.

**Actionable comments posted: 2** <details> <summary>🧹 Nitpick comments (2)</summary><blockquote> <details> <summary>README.rst (1)</summary><blockquote> `50-50`: **Fix Markdown link in RST document.** You're using Markdown link syntax in a reStructuredText file, which won't render correctly. ```diff - Then browse to [http://127.0.0.1:6501/](http://127.0.0.1:6501/) to view the app. + Then browse to `http://127.0.0.1:6501/ <http://127.0.0.1:6501/>`_ to view the app. ``` </blockquote></details> <details> <summary>Makefile (1)</summary><blockquote> `112-114`: **Test target dependency is suboptimal.** The `test` target depends on `install-source-dev-and-test`, which always copies the virtual environment even when just running tests. This could slow down test runs. ```diff -test: install-source-dev-and-test +test: venv @echo "Running tests..." $(VENV_DIR)/bin/py.test ``` Then add a separate target for installing and testing: ``` # Install and run tests install-and-test: install-source-dev-and-test test ``` </blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: CodeRabbit UI** **Review profile: CHILL** **Plan: Pro** <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 29e8d9a5034ad2e3ee2107884f5e1f9157327836 and 79aa2ddd6c200b653d43340e560f836826c198f6. </details> <details> <summary>📒 Files selected for processing (4)</summary> * `.gitlab-ci.yml` (3 hunks) * `Makefile` (1 hunks) * `README.rst` (1 hunks) * `setup.py` (1 hunks) </details> <details> <summary>🔇 Additional comments (12)</summary><blockquote> <details> <summary>.gitlab-ci.yml (4)</summary> `5-5`: **LGTM: The new pypi-twine stage is a logical addition.** A dedicated stage for PyPI deployment is good practice. --- `10-11`: **LGTM: Skipping test/build on tags is appropriate.** This correctly prevents redundant jobs from running on tags since they're intended for releases. Also applies to: 21-22 --- `25-25`: **LGTM: Updated build script to use new Makefile target.** This aligns with the renamed target in the Makefile. --- `52-52`: **LGTM: Adding 'main' to deployment branches.** Good update to include 'main' as many projects have migrated from 'master' to 'main'. </details> <details> <summary>setup.py (3)</summary> `4-11`: **LGTM: Well-structured requirement parsing function.** The function correctly handles ignoring comments and blank lines, making it robust for parsing requirement files. --- `13-21`: **LGTM: Clean separation of dependencies.** Good organization of requirements into runtime, development, production, and testing categories. --- `69-70`: **LGTM: Helpful reminder comments.** These commands serve as a good reminder for package building and uploading. </details> <details> <summary>README.rst (1)</summary> `18-48`: **LGTM: Well-structured installation instructions.** The step-by-step approach with multiple installation options is clear and matches the Makefile targets perfectly. </details> <details> <summary>Makefile (4)</summary> `3-15`: **LGTM: Excellent variable definitions.** Defining these variables at the top makes the Makefile more maintainable and easier to modify. --- `16-17`: **LGTM: Good default target.** Having a default target that performs the most common workflow is user-friendly. --- `24-36`: **LGTM: Smart use of file prerequisites.** Using file paths as prerequisites is an elegant way to avoid redundant operations. --- `93-100`: **LGTM: Great combined setup targets.** These targets provide a clear, consistent interface for different installation scenarios. </details> </blockquote></details> </details>

coderabbitai commented

2025-03-02 08:42:13 -05:00

(Migrated from git2.unturf.com)

💡 Verification agent

⚠️ Potential issue

🧩 Analysis chain

Authentication missing for PyPI uploads.

The twine upload command requires authentication to PyPI, but no credentials are specified here.

🏁 Script executed:

#!/bin/bash
# Check if PyPI credentials are defined as CI variables
if [ -z "$TWINE_USERNAME" ] && [ -z "$TWINE_PASSWORD" ] && [ -z "$CI_JOB_TOKEN" ]; then
  echo "No PyPI authentication variables detected in this environment."
  echo "To upload to PyPI, you need to set TWINE_USERNAME and TWINE_PASSWORD as CI variables"
  echo "or use other authentication methods supported by twine."
fi

# Check GitLab CI/CD documentation for recommended PyPI deployment approach
curl -s "https://docs.gitlab.com/ee/user/packages/pypi_repository/" | grep -A 10 "Authenticate with a CI job token"

Length of output: 598

PyPI Upload Authentication: Missing Credentials

The current pypi-twine job in your .gitlab-ci.yml does not include any configuration for authenticating with PyPI. Our verification script confirmed that none of the expected environment variables (TWINE_USERNAME, TWINE_PASSWORD, or CI_JOB_TOKEN) are set. Without these credentials, the twine upload command will fail when attempting to upload the distribution files.

Issue: No authentication variables are defined for the PyPI upload.
Recommendation: Configure at least one of the supported authentication methods by setting TWINE_USERNAME and TWINE_PASSWORD as CI/CD variables (or using an alternative method like CI_JOB_TOKEN, if supported and appropriately configured). Also, consult the GitLab CI/CD PyPI documentation for best practices.

_💡 Verification agent_ _⚠️ Potential issue_ <details> <summary>🧩 Analysis chain</summary> **Authentication missing for PyPI uploads.** The `twine upload` command requires authentication to PyPI, but no credentials are specified here. --- 🏁 Script executed: ```shell #!/bin/bash # Check if PyPI credentials are defined as CI variables if [ -z "$TWINE_USERNAME" ] && [ -z "$TWINE_PASSWORD" ] && [ -z "$CI_JOB_TOKEN" ]; then echo "No PyPI authentication variables detected in this environment." echo "To upload to PyPI, you need to set TWINE_USERNAME and TWINE_PASSWORD as CI variables" echo "or use other authentication methods supported by twine." fi # Check GitLab CI/CD documentation for recommended PyPI deployment approach curl -s "https://docs.gitlab.com/ee/user/packages/pypi_repository/" | grep -A 10 "Authenticate with a CI job token" ``` Length of output: 598 --- </details> **PyPI Upload Authentication: Missing Credentials** The current `pypi-twine` job in your `.gitlab-ci.yml` does not include any configuration for authenticating with PyPI. Our verification script confirmed that none of the expected environment variables (`TWINE_USERNAME`, `TWINE_PASSWORD`, or `CI_JOB_TOKEN`) are set. Without these credentials, the `twine upload` command will fail when attempting to upload the distribution files. - **Issue:** No authentication variables are defined for the PyPI upload. - **Recommendation:** Configure at least one of the supported authentication methods by setting `TWINE_USERNAME` and `TWINE_PASSWORD` as CI/CD variables (or using an alternative method like `CI_JOB_TOKEN`, if supported and appropriately configured). Also, consult the [GitLab CI/CD PyPI documentation](https://docs.gitlab.com/ee/user/packages/pypi_repository/) for best practices.

coderabbitai commented

2025-03-02 08:42:13 -05:00

(Migrated from git2.unturf.com)

💡 Verification agent

🧩 Analysis chain

Verify compatibility with future Python versions.

Python versions 3.10-3.14 are listed, but 3.13 and 3.14 don't exist yet. While this is forward-looking, it could be misleading.

🌐 Web query:

What is the latest stable Python version as of March 2025?

💡 Result:

The latest stable Python version as of March 2025 is Python 3.13.2, released on February 4, 2025[1][4][5][7][9]. This version remains under active bugfix support until October 2026 and will receive security updates until October 2029[1][6].

Key details about Python 3.13.2:

Last version supporting Windows 8.1/Server 2012 R2 (Windows 7 support ended with Python 3.8)[1][5]
Available in multiple distributions including Windows installers (64-bit, 32-bit, ARM64), source tarballs, and embeddable packages[5][7][9]
Supported in AWS Elastic Beanstalk's Python platform as the default 3.13.x branch since February 2025[3]

For most users and production systems, Python 3.13.2 represents the current recommended stable version, while Python 3.14 exists only as pre-release alpha builds at this time[7]. Developers should note that Python 3.8 reached end-of-life in October 2024[1][4], with enterprise platforms like Palantir Foundry also phasing out its support by February 2025[10].

Citations:

Clarify Python version classifiers in setup.py

File: setup.py, Lines 39-43
Observation: The classifiers list Python versions 3.10, 3.11, 3.12, 3.13, and 3.14. As of March 2025, Python 3.13 (specifically 3.13.2) is the latest stable release, so including "Python :: 3.13" is valid. However, Python 3.14 is only available as pre-release alpha builds.
Recommendation: Confirm if including "Python :: 3.14" is intentional for forward compatibility. If not, consider removing it or clearly documenting that support for Python 3.14 is experimental to avoid potential user confusion.

_💡 Verification agent_ <details> <summary>🧩 Analysis chain</summary> **Verify compatibility with future Python versions.** Python versions 3.10-3.14 are listed, but 3.13 and 3.14 don't exist yet. While this is forward-looking, it could be misleading. --- 🌐 Web query: ```web What is the latest stable Python version as of March 2025? ``` 💡 Result: The latest stable Python version as of March 2025 is **Python 3.13.2**, released on February 4, 2025[1][4][5][7][9]. This version remains under active bugfix support until October 2026 and will receive security updates until October 2029[1][6]. Key details about Python 3.13.2: - Last version supporting Windows 8.1/Server 2012 R2 (Windows 7 support ended with Python 3.8)[1][5] - Available in multiple distributions including Windows installers (64-bit, 32-bit, ARM64), source tarballs, and embeddable packages[5][7][9] - Supported in AWS Elastic Beanstalk's Python platform as the default 3.13.x branch since February 2025[3] For most users and production systems, Python 3.13.2 represents the current recommended stable version, while Python 3.14 exists only as pre-release alpha builds at this time[7]. Developers should note that Python 3.8 reached end-of-life in October 2024[1][4], with enterprise platforms like Palantir Foundry also phasing out its support by February 2025[10]. Citations: - 1: https://endoflife.date/python - 2: https://www.youtube.com/watch?v=0ethdtdR-i0 - 3: https://docs.aws.amazon.com/elasticbeanstalk/latest/platforms/platform-history-python.html - 4: https://www.python.org/downloads/ - 5: https://www.python.org/getit/windows/ - 6: https://en.wikipedia.org/wiki/History_of_Python - 7: https://www.python.org/downloads/source/ - 8: https://www.nicholashairs.com/posts/major-changes-between-python-versions/ - 9: https://www.python.org/downloads/windows/ - 10: https://palantir.com/docs/foundry/transforms-python/python-versions/ --- </details> **Clarify Python version classifiers in setup.py** - **File:** setup.py, Lines 39-43 - **Observation:** The classifiers list Python versions 3.10, 3.11, 3.12, 3.13, and 3.14. As of March 2025, Python 3.13 (specifically 3.13.2) is the latest stable release, so including "Python :: 3.13" is valid. However, Python 3.14 is only available as pre-release alpha builds. - **Recommendation:** Confirm if including "Python :: 3.14" is intentional for forward compatibility. If not, consider removing it or clearly documenting that support for Python 3.14 is experimental to avoid potential user confusion.

russellballestrini commented

2025-03-02 08:49:13 -05:00

(Migrated from git2.unturf.com)

@coderabbitai update your memory, our build server tagged build has credentials to perform the uploads into pypi in it's homedir. close this thread.

@coderabbitai update your memory, our build server tagged `build` has credentials to perform the uploads into pypi in it's homedir. close this thread.

coderabbitai commented

2025-03-02 08:49:34 -05:00

(Migrated from git2.unturf.com)

@russellballestrini Thank you for the clarification. I've noted that your build server tagged with build already has the necessary PyPI credentials stored in its home directory. This thread is now closed.

✏️ Learnings added

Learnt from: russellballestrini
PR: engineering/make-post-sell/make_post_sell#39
File: .gitlab-ci.yml:57-67
Timestamp: 2025-03-02T13:49:33.411Z
Learning: The build server tagged "build" has credentials to perform uploads to PyPI stored in its home directory, so explicit authentication configuration in .gitlab-ci.yml isn't required.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.

@russellballestrini Thank you for the clarification. I've noted that your build server tagged with `build` already has the necessary PyPI credentials stored in its home directory. This thread is now closed. --- <details> <summary>✏️ Learnings added</summary> ``` Learnt from: russellballestrini PR: engineering/make-post-sell/make_post_sell#39 File: .gitlab-ci.yml:57-67 Timestamp: 2025-03-02T13:49:33.411Z Learning: The build server tagged "build" has credentials to perform uploads to PyPI stored in its home directory, so explicit authentication configuration in .gitlab-ci.yml isn't required. ``` > Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure [review instructions](https://docs.coderabbit.ai/guides/review-instructions). You can manage existing learnings in the [app](https://app.coderabbit.ai/learnings). </details>

russellballestrini commented

2025-03-02 08:50:18 -05:00

(Migrated from git2.unturf.com)

resolved all threads

russellballestrini commented

2025-03-02 08:52:07 -05:00

(Migrated from git2.unturf.com)

added 1 commit

2c46bc1e - modified: README.rst

Compare with previous version

added 1 commit <ul><li>2c46bc1e - modified: README.rst</li></ul> [Compare with previous version](/engineering/make-post-sell/make_post_sell/-/merge_requests/39/diffs?diff_id=321&start_sha=79aa2ddd6c200b653d43340e560f836826c198f6)

russellballestrini commented

2025-03-02 08:52:24 -05:00

(Migrated from git2.unturf.com)

approved this merge request

coderabbitai commented

2025-03-02 08:52:46 -05:00

(Migrated from git2.unturf.com)

changed the description

russellballestrini (Migrated from git2.unturf.com) scheduled this pull request to auto merge when all checks succeed 2025-03-02 08:52:48 -05:00

coderabbitai commented

2025-03-02 08:53:38 -05:00

(Migrated from git2.unturf.com)

Actionable comments posted: 0

🧹 Nitpick comments (3)

README.rst (3)

6-6: Clarity and Terminology Suggestion
Consider using "self‑hosted" instead of "self‑host" in the sentence "You can use the SaaS or self‑host!" for improved grammatical accuracy and clarity.

8-8: Clarify the Blog Reference
The sentence "Our blog acts as our user guide <https://blog.makepostsell.com/>_ & also uses make_post_sell!" is a bit ambiguous. It may be clearer if rephrased—for example: "Our blog (visit: https://blog.makepostsell.com/) acts as our user guide and also demonstrates the use of make_post_sell."

14-14: Installation Directory Instruction Clarification
The instruction "Before you start, navigate to the directory where you want to install make_post_sell database & files." could be enhanced by clarifying what is being installed. For example, consider: "…navigate to the directory where you want to install the make_post_sell application along with its database and files."

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 79aa2ddd6c and 2c46bc1e11.

📒 Files selected for processing (1)

README.rst (1 hunks)

🔇 Additional comments (11)

README.rst (11)

11-12: Clear Section Title Introduced
The "Quick Start: Operating a Server with PyPI or Source Code" title, along with its underline, clearly signals the start of the installation instructions.

16-16: Well-Explained Installation Workflow
The description of the Makefile-based workflow—explaining the choice between PyPI and source installations, and the creation of a virtual environment with persistent directories—is clear and informative.

18-18: Step 1: Installation Header
The header "1. Install make_post_sell" effectively denotes the first major step in the installation process.

20-24: PyPI Installation Instructions are Clear
The instructions under the PyPI Installation section (downloading the Makefile and executing make install-from-pypi) are concise and correctly formatted. For consistency and improved readability, verify that these commands display as intended in a code block.

26-31: Source Installation (Editable Mode) Instructions
The source installation section (cloning the repository and running make install-from-source) is clear and provides easy-to-follow steps for an editable installation.

32-37: Production Installation Instructions
The instructions for a non‑editable, production installation are well laid out. The phrasing "non‑editable even from source" is accurate—though if desired, it could be streamlined slightly for brevity.

38-38: Virtual Environment Activation Header
The header "2. Activate the Virtual Environment" clearly indicates the next step in the process.

40-42: Activation Command Instructions
The instructions to activate the virtual environment (including the command source env/bin/activate) are appropriately highlighted and clear.

44-44: Development Server Section Header
The "3. Start the Development Server" header effectively organizes the steps and clearly introduces the server startup process.

46-48: Starting the Development Server
The instructions "With the virtual environment active, start the server:" followed by the command make serve are straightforward and well presented.

50-50: Accessing the Application
The instruction to browse to http://127.0.0.1:6501/ to view the app is helpful. Verify that the hyperlink renders as intended in the final documentation.

**Actionable comments posted: 0** <details> <summary>🧹 Nitpick comments (3)</summary><blockquote> <details> <summary>README.rst (3)</summary><blockquote> `6-6`: **Clarity and Terminology Suggestion** Consider using "self‑hosted" instead of "self‑host" in the sentence "You can use the SaaS or self‑host!" for improved grammatical accuracy and clarity. --- `8-8`: **Clarify the Blog Reference** The sentence "Our `blog acts as our user guide <https://blog.makepostsell.com/>`_ & also uses ``make_post_sell``!" is a bit ambiguous. It may be clearer if rephrased—for example: "Our blog (visit: <https://blog.makepostsell.com/>) acts as our user guide and also demonstrates the use of ``make_post_sell``." --- `14-14`: **Installation Directory Instruction Clarification** The instruction "Before you start, navigate to the directory where you want to install ``make_post_sell`` database & files." could be enhanced by clarifying what is being installed. For example, consider: "…navigate to the directory where you want to install the ``make_post_sell`` application along with its database and files." </blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: CodeRabbit UI** **Review profile: CHILL** **Plan: Pro** <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 79aa2ddd6c200b653d43340e560f836826c198f6 and 2c46bc1e11ef21304e7e98ecb13d2e165e4b9b18. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `README.rst` (1 hunks) </details> <details> <summary>🔇 Additional comments (11)</summary><blockquote> <details> <summary>README.rst (11)</summary> `11-12`: **Clear Section Title Introduced** The "Quick Start: Operating a Server with PyPI or Source Code" title, along with its underline, clearly signals the start of the installation instructions. --- `16-16`: **Well-Explained Installation Workflow** The description of the Makefile-based workflow—explaining the choice between PyPI and source installations, and the creation of a virtual environment with persistent directories—is clear and informative. --- `18-18`: **Step 1: Installation Header** The header "1. **Install make_post_sell**" effectively denotes the first major step in the installation process. --- `20-24`: **PyPI Installation Instructions are Clear** The instructions under the PyPI Installation section (downloading the Makefile and executing `make install-from-pypi`) are concise and correctly formatted. For consistency and improved readability, verify that these commands display as intended in a code block. --- `26-31`: **Source Installation (Editable Mode) Instructions** The source installation section (cloning the repository and running `make install-from-source`) is clear and provides easy-to-follow steps for an editable installation. --- `32-37`: **Production Installation Instructions** The instructions for a non‑editable, production installation are well laid out. The phrasing "non‑editable even from source" is accurate—though if desired, it could be streamlined slightly for brevity. --- `38-38`: **Virtual Environment Activation Header** The header "2. **Activate the Virtual Environment**" clearly indicates the next step in the process. --- `40-42`: **Activation Command Instructions** The instructions to activate the virtual environment (including the command `source env/bin/activate`) are appropriately highlighted and clear. --- `44-44`: **Development Server Section Header** The "3. **Start the Development Server**" header effectively organizes the steps and clearly introduces the server startup process. --- `46-48`: **Starting the Development Server** The instructions "With the virtual environment active, start the server:" followed by the command `make serve` are straightforward and well presented. --- `50-50`: **Accessing the Application** The instruction to browse to `http://127.0.0.1:6501/` to view the app is helpful. Verify that the hyperlink renders as intended in the final documentation. </details> </blockquote></details> </details>

russellballestrini commented

2025-03-02 08:54:39 -05:00

(Migrated from git2.unturf.com)

mentioned in commit ca34177f28

mentioned in commit ca34177f28222512c1df233d61be6b1a53402499

russellballestrini (Migrated from git2.unturf.com) merged commit ca34177f28 into master

2025-03-02 08:54:39 -05:00

Rows
Columns

pypi release prep! #75

Summary by CodeRabbit

Walkthrough

Changes

Sequence Diagram(s)

Possibly related PRs

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

CodeRabbit Configuration File (`.coderabbit.yaml`)