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.

Sign up for GitHub

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

Jump to bottom

[FEATURE] Add support to PIP/PyPI - Python #229

Open
guibranco opened this issue Jun 24, 2023 · 3 comments · May be fixed by #546
Open

[FEATURE] Add support to PIP/PyPI - Python #229

guibranco opened this issue Jun 24, 2023 · 3 comments · May be fixed by #546
Labels
dependencies Pull requests that update a dependency file 📝 documentation Tasks related to writing or updating documentation enhancement A enhancement to the project gitauto GitAuto label to trigger the app in a issue. good first issue A issue for someone self assign and help me =D hacktoberfest Participation in the Hacktoberfest event help wanted Feel free to take this issue for you and help me! :octocat: github-actions GitHub Actions for automation and CI/CD packages Publishing packages python Pyhton 🛠 WIP Work in progress

Comments

@guibranco
Copy link
Owner

guibranco commented Jun 24, 2023 •
edited
Loading

Description

We need to create a Python package for this repository and publish it to PyPi to make it easier for developers to install and use it in their Python projects. Packaging the repository will also enhance the distribution, versioning, and accessibility of the code.

Why We Need This

  1. Easy Installation: Publishing the repository as a PyPi package allows users to install it via pip without needing to clone the repository or manage dependencies manually.
  2. Version Control: PyPi enables versioning, allowing developers to install specific versions of the package.
  3. Distribution: It makes it easier for other developers to discover and use the package in their own projects.

Steps to Proceed

Here are the steps to package and publish the repository to PyPi:

  1. Create setup.py: This file should include details like package name, version, description, dependencies, and more. Refer to this guide on setup.py for instructions.

  2. Generate the Distribution Package:

    • Ensure all required files like LICENSE and README.md are included.
    • Run the following commands to create the source distribution and wheel distribution: 
      python setup.py sdist bdist_wheel
      Detailed instructions can be found here.

  3. Test the Package on TestPyPi:

    • Before publishing to the main PyPi, upload the package to TestPyPi to ensure everything works as expected: 
      python -m twine upload --repository testpypi dist/*
      You can find more information about TestPyPi here.

  4. Publish to PyPi:

    • Once the package is verified on TestPyPi, upload it to the official PyPi repository: 
      python -m twine upload dist/*
      Additional instructions on uploading to PyPi are available here.

  5. Add Badges: After publishing, update the repository's README with a PyPi badge to show the package status and ease future version management.

Tech notes

Additional information

No response
@guibranco guibranco added enhancement A enhancement to the project dependencies Pull requests that update a dependency file :octocat: github-actions GitHub Actions for automation and CI/CD 📝 documentation Tasks related to writing or updating documentation packages Publishing packages python Pyhton help wanted Feel free to take this issue for you and help me! good first issue A issue for someone self assign and help me =D labels Jun 24, 2023
@guibranco guibranco self-assigned this Jul 27, 2023
@guibranco guibranco added WIP and removed help wanted Feel free to take this issue for you and help me! good first issue A issue for someone self assign and help me =D labels Jul 27, 2023
@guibranco guibranco added the hacktoberfest Participation in the Hacktoberfest event label Oct 7, 2023
@guibranco guibranco removed their assignment Dec 11, 2023
@guibranco guibranco added help wanted Feel free to take this issue for you and help me! good first issue A issue for someone self assign and help me =D and removed WIP labels Apr 21, 2024
@guibranco guibranco changed the title Add PIP/PyPI support [FEATURE] Add PIP/PyPI support May 15, 2024
@gitauto-ai gitauto-ai bot added the gitauto GitAuto label to trigger the app in a issue. label Jul 22, 2024
@gitauto-ai GitAuto AI
Copy link
Contributor

gitauto-ai bot commented Jul 22, 2024 •
edited
Loading

@guibranco Pull request completed! Check it out here #430 🚀

Note: I automatically create a pull request for an unassigned and open issue in order from oldest to newest once a day at 00:00 UTC, as long as you have remaining automation usage. Should you have any questions or wish to change settings or limits, please feel free to contact [email protected] or invite us to Slack Connect.

@gitauto-ai gitauto-ai bot mentioned this issue Jul 22, 2024
Closed
@guibranco guibranco changed the title [FEATURE] Add PIP/PyPI support [FEATURE] Add PIP/PyPI support Jul 26, 2024
@guibranco guibranco removed the gitauto GitAuto label to trigger the app in a issue. label Aug 16, 2024
@guibranco guibranco linked a pull request Aug 16, 2024 that will close this issue
Add PIP/PyPI support with gitauto model #430
Closed
@gstraccini gstraccini bot added the 🛠 WIP Work in progress label Aug 19, 2024
@gitauto-ai gitauto-ai bot added the gitauto GitAuto label to trigger the app in a issue. label Aug 22, 2024
@gitauto-ai GitAuto AI
Copy link
Contributor

gitauto-ai bot commented Aug 22, 2024 •
edited
Loading

@guibranco Pull request completed! Check it out here #476 🚀

Note: I automatically create a pull request for an unassigned and open issue in order from oldest to newest once a day at 00:00 UTC, as long as you have remaining automation usage. Should you have any questions or wish to change settings or limits, please feel free to contact [email protected] or invite us to Slack Connect.

@gitauto-ai gitauto-ai bot mentioned this issue Aug 22, 2024
Closed
@guibranco guibranco removed 🛠 WIP Work in progress gitauto GitAuto label to trigger the app in a issue. labels Aug 30, 2024
@guibranco guibranco changed the title [FEATURE] Add PIP/PyPI support [FEATURE] Add support to PIP/PyPI - Python Sep 13, 2024
@gitauto-ai gitauto-ai bot added the gitauto GitAuto label to trigger the app in a issue. label Sep 23, 2024
@gitauto-ai GitAuto AI
Copy link
Contributor

gitauto-ai bot commented Sep 23, 2024 •
edited
Loading

@guibranco Pull request completed! Check it out here #546 🚀

Note: I automatically create a pull request for an unassigned and open issue in order from oldest to newest once a day at 00:00 UTC, as long as you have remaining automation usage. Should you have any questions or wish to change settings or limits, please feel free to contact [email protected] or invite us to Slack Connect.

@gitauto-ai gitauto-ai bot linked a pull request Sep 23, 2024 that will close this issue
Open
@gstraccini gstraccini bot added the 🛠 WIP Work in progress label Sep 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
dependencies Pull requests that update a dependency file 📝 documentation Tasks related to writing or updating documentation enhancement A enhancement to the project gitauto GitAuto label to trigger the app in a issue. good first issue A issue for someone self assign and help me =D hacktoberfest Participation in the Hacktoberfest event help wanted Feel free to take this issue for you and help me! :octocat: github-actions GitHub Actions for automation and CI/CD packages Publishing packages python Pyhton 🛠 WIP Work in progress
Projects
None yet
Milestone
No milestone
1 participant
@guibranco