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

Make zs-yaml pip installable #3

Open
MisterGC opened this issue Jun 6, 2024 · 0 comments
Open

Make zs-yaml pip installable #3

MisterGC opened this issue Jun 6, 2024 · 0 comments
Assignees
Milestone

Comments

@MisterGC
Copy link
Contributor

MisterGC commented Jun 6, 2024

It would be beneficial for users to be able to install zs-yaml directly via pip. This would streamline the installation process and make the package more accessible. Here are the steps that could be taken to achieve this:

  1. Create a setup.py File:

    • Ensure that the setup.py file includes all the necessary information such as package name, version, author details, description, and required dependencies.
  2. Prepare the Project for Distribution:

    • Ensure that all necessary files (e.g., README.md, LICENSE, MANIFEST.in) are included in the distribution package.
  3. Build the Distribution Package:

    • Use setuptools to build the distribution package. This typically involves running:
      python setup.py sdist bdist_wheel
  4. Upload to PyPI:

    • Register the package on PyPI (if not already done) and upload the distribution package using Twine:
      twine upload dist/*
  5. Update Documentation:

    • Provide installation instructions in the README file, indicating how users can install the package using pip:
      pip install zs-yaml

Acceptance Criteria:

  • The package should be successfully uploaded to PyPI.
  • Users should be able to install the package via pip install zs-yaml.
  • Installation instructions should be clear and included in the README.
@MisterGC MisterGC added this to the First Release milestone Jun 19, 2024
@MisterGC MisterGC self-assigned this Jul 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant