AnswerDotAI / AnswerDotAI/nbdev

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

Aperta
#1,447 0 commenti 4 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Jupyter Notebook
Stelle
5.3k
Fork
513
Merge medio
2g 30m
PR unite (30g)
8

Descrizione

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!

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia confrontando settings.ini e pyproject.toml, quindi esamina come vengono generati i metadati di PyPI e l'indice di GitHub Pages. Conferma quale configurazione controlla gli URL del progetto e l'URL di base dei collegamenti ai simboli di nbdev; il lavoro è completato quando vengono documentate la precedenza e la fonte autorevole richiesta per ogni correzione.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
jupyter, python
Ambito
developer-experience, documentation
Tipo di issue
Documentazione
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.