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

Update package layout to PyAnsys guidelines #296

Open
2 of 17 tasks
jorgepiloto opened this issue Jul 8, 2022 · 0 comments
Open
2 of 17 tasks

Update package layout to PyAnsys guidelines #296

jorgepiloto opened this issue Jul 8, 2022 · 0 comments
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers maintenance Repository structure maintenance

Comments

@jorgepiloto
Copy link
Member

jorgepiloto commented Jul 8, 2022

As with other projects in the PyAnsys ecosystem, the layout of this project should adapt to the general guidelines.

Low effort

Intermediate effort

  • Use a src/ layout. Just need to move the "ansys/" dir inside a "src/" one and fix some links to this new location: Use src/ dir #664

  • Use a pyproject.toml and drop any setup.py or setup.cfg files.

  • Rename /docs directory to /doc: Link issue here.

  • Implement Tox for the project

    • Drop any patch scripts in favor of Tox
  • Use sphinx-autoapi for generating the API reference, see doc: use sphinx-autoapi for API reference #1952

High effort

  • Use containers from the GitHub Container Registry in the CI/CD
  • Rename master branch to main
  • Use semver tags

More about packaging guidelines in https://dev.docs.pyansys.com/packaging/structure.html.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers maintenance Repository structure maintenance
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants