Organizar e facilitar o acesso a dados brasileiros através de tabelas públicas no BigQuery.
Project description
Python Package
Desenvolvimento Linux e Mac:
Clone o repositório principal:
git clone https://github.com/basedosdados/mais.git
Entre na pasta local do repositório usando cd mais/
e suba o ambiente localmente:
make create-env
. .mais/bin/activate
cd python-package/
python setup.py develop
Desenvolva uma nova feature
- Abra uma branch com o nome issue-
- Faça as modificações necessárias
- Suba o Pull Request apontando para a branch
python-next-minor
oupython-next-patch
. Sendo, minor e patch referentes ao bump da versão: v1.5.7 --> v<major>.<minor>.<patch>. - O nome do PR deve seguir o padrão
[infra] <titulo explicativo>
O que uma modificação precisa ter
- Resolver o problema
- Lista de modificações efetuadas
- Mudei a função X para fazer Y
- Troquei o nome da variavel Z
- Referência aos issues atendidos
- Documentação e Docstrings
- Testes
Versionamento
Para publicar uma nova versão do pacote é preciso seguir os seguintes passos:
-
Fazer o pull da branch:
git pull origin [python-version]
Onde
[python-version]
é a branch da nova versão do pacote. -
Se necessario adicionar novas dependências:
poetry add <package-name>
-
Gerar novo
requirements-dev.txt
poetry export -f requirements.txt --output requirements-dev.txt --without-hashes
-
Editar
pyproject.toml
:O arquivo
pyproject.toml
contém, entre outras informações, a versão do pacote em python da BD. Segue excerto do arquivo:description = "Organizar e facilitar o acesso a dados brasileiros através de tabelas públicas no BigQuery." homepage = "https://github.com/base-dos-dados/bases" license = "MIT" name = "basedosdados" packages = [ {include = "basedosdados"}, ] readme = "README.md" repository = "https://github.com/base-dos-dados/bases" version = "1.6.1-beta.2"
O campo
version
deve ser alterado para o número da versão sendo lançada. -
Editar
basedosdados/__init__.py
:O arquivo
basedosdados/__init__.py
contém a versão do pacote em python da BD. Exemplo:__version__ = "1.6.1-beta.2"
O atributo
__version__
também deve ser alterado para o número da versão sendo lançada. -
Push para branch:
git push origin [python-version]
-
Publicação do pacote no PyPI (exige usuário e senha): Para publicar o pacote no PyPI, use:
Para publicar o pacote no PyPI, use:
poetry version [python-version] poetry publish --build
-
Faz merge da branch para a master
-
Faz release usando a UI do GitHub
-
Atualizar versão do pacote usada internamente
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for basedosdados-2.0.0b18-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 60237b2c6f1ae528be5b894a865bcb4598b7753aebe5124fb0db22f75f9783bf |
|
MD5 | fb49c89ca1adc15c89b20fbbb19abbd5 |
|
BLAKE2b-256 | 2f44ec07f52dd85cba3916b5e773d6c8366137ac433f9867d66c49d9f841aa0e |