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

Clarification on updating project metadata: settings.ini vs pyproject.toml #1447

Open
nicomarr opened this issue Sep 13, 2024 · 0 comments
Open

Comments

@nicomarr
Copy link

I'm seeking clarification on the correct approach to update project metadata for an existing project, particularly for PyPI configuration. My current setup includes both a settings.ini file and a pyproject.toml file, and I'm unsure which one takes precedence or if both need to be updated.

Current situation:
My project is already released on PyPI and its documentation is hosted on GitHub pages. Some metadata appears to be incorrectly set, possibly due to discrepancies between my PyPI and GitHub usernames. I need to update the following:

  • Project URLs (Homepage link on PyPI)
  • Auto-generated links in the documentation on GitHub pages (index page) for symbols with backticks, for which nbdev links to that symbol’s reference page. Of note, the respective links in the auto-generated README file and on PyPI are correct. The issue is an incorrect base url to my GitHub repo.

My questions: Can I make changes directly in the pyproject.toml file to configure metadata for PyPI, or should this be done via settings.ini? If both files are present, which one takes precedence for PyPI metadata?

Any guidance on the best practices for managing project metadata in this scenario would be greatly appreciated. Thank you!

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