Fix installation docs: replace PyPI references with GitHub archive URLs#1126
Fix installation docs: replace PyPI references with GitHub archive URLs#1126robertatakenaka merged 3 commits intomasterfrom
Conversation
Since packtools is not published on PyPI, update all documentation to use GitHub archive URLs for installation instead of pip install from PyPI. Also update the git protocol URL to HTTPS and remove the outdated Windows installation section referencing Python 2.7. Co-authored-by: robertatakenaka <[email protected]>
There was a problem hiding this comment.
Pull request overview
Updates installation documentation to reflect that packtools is not published on PyPI, pointing users to GitHub sources/releases instead.
Changes:
- Replaces
pip install packtoolsinstructions with GitHub archive (tag) URLs. - Updates VCS install instructions to use HTTPS instead of
git://. - Removes obsolete Windows installation section referencing Python 2.7 / old packtools versions.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Updates primary installation commands to use GitHub tag archives and HTTPS VCS URL; adjusts webapp install syntax. |
| docs/install.rst | Replaces PyPI install section with GitHub archive URL and removes outdated Windows guidance. |
| scripts/README.rst | Replaces PyPI link with GitHub repository link for locating scripts. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| These scripts are not part of the standard python package, available at | ||
| https://pypi.python.org/pypi/packtools. | ||
| https://github.com/scieloorg/packtools. |
There was a problem hiding this comment.
This link points to the repository root, but the text refers specifically to “These scripts”. Consider linking directly to the scripts/ directory (or the relevant file path) so readers land on the scripts rather than the repo homepage.
| https://github.com/scieloorg/packtools. | |
| https://github.com/scieloorg/packtools/tree/master/scripts. |
| .. code-block:: bash | ||
|
|
||
| $ pip install packtools | ||
| $ pip install https://github.com/scieloorg/packtools/archive/refs/tags/4.16.0.zip |
There was a problem hiding this comment.
@copilot adicione um texto anterior para que o usuário verifique qual é a versão mais recente, pois pela versão mais recente tem que ir para o comando... ou melhor... o usuário não deveria usar o requirements.txt?
There was a problem hiding this comment.
Added guidance text directing users to check the latest version at the GitHub releases page before running the install command. Updated in both docs/install.rst and README.md. See commit 9b4a550.
Direct users to the GitHub releases page to find the latest version before running pip install, since the version in the URL example will become outdated. Also fix scripts/README.rst to link directly to the scripts directory. Co-authored-by: robertatakenaka <[email protected]>
O que esse PR faz?
packtools não está no PyPI. Atualiza a documentação de instalação no repositório para usar URLs de arquivo do GitHub em vez de
pip install packtools.README.md:pip install packtools→pip install https://github.com/scieloorg/packtools/archive/refs/tags/4.16.0.zip; protocolo gitgit://→https://; instalação webapp atualizada; adicionada orientação para verificar a versão mais recente na página de releases do GitHubdocs/install.rst: Seção PyPI → GitHub; removida seção Windows obsoleta (referenciava Python 2.7 e packtools 2.0.1); adicionada orientação para verificar a versão mais recente na página de releasesscripts/README.rst: URL PyPI → URL do diretório de scripts no GitHub (/tree/master/scripts)Nota: As páginas wiki (XML-Data-Checker, XML-to-PDF-Converter, XML-to-PDF-Converter-Library) precisam da mesma correção manualmente via interface do wiki.
Onde a revisão poderia começar?
README.md— contém as principais mudanças de instrução de instalação.Como este poderia ser testado manualmente?
Validar que os URLs do GitHub funcionam:
Algum cenário de contexto que queira dar?
Os comandos
pip install packtoolsepip install packtools>=4.10.0falham porque o pacote não está publicado no PyPI. A seção Windows emdocs/install.rstreferenciava Python 2.7.3 e packtools 2.0.1 — completamente obsoleta. Como a versão no URL de exemplo ficará desatualizada, foi adicionada orientação para que o usuário verifique a versão mais recente na página de releases do GitHub antes de executar o comando.Screenshots
N/A — mudanças apenas em documentação.
Quais são tickets relevantes?
Referências
https://github.com/scieloorg/packtools/archive/refs/tags/{version}.zippacktools[webapp] @ URLOriginal prompt
🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.