# Python Package
## Desenvolvimento Linux e Mac:
Clone o repositório principal:
```sh
git clone https://github.com/basedosdados/mais.git
```
Entre na pasta local do repositório usando `cd mais/` e suba o ambiente localmente:
```sh
make create-env
. .mais/bin/activate
cd python-package/
python setup.py develop
```
### Desenvolva uma nova feature
1. Abra uma branch com o nome issue-<X>
2. Faça as modificações necessárias
3. Suba o Pull Request apontando para a branch `python-next-minor` ou `python-next-patch`.
Sendo, minor e patch referentes ao bump da versão: v1.5.7 --> v\<major>.\<minor>.\<patch>.
4. 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
1. Mudei a função X para fazer Y
2. 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:**
1. Fazer o pull da branch:
```bash
git pull origin [python-version]
```
Onde `[python-version]` é a branch da nova versão do pacote.
2. Se necessario adicionar novas dependências:
```bash
poetry add <package-name>
```
3. Gerar novo `requirements-dev.txt`
```bash
poetry export -f requirements.txt --output requirements-dev.txt --without-hashes
```
4. 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:
```toml
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.
5. Editar `basedosdados/__init__.py`:
O arquivo `basedosdados/__init__.py` contém a versão do pacote em python da **BD**. Exemplo:
```python
__version__ = "1.6.1-beta.2"
```
O atributo `__version__` também deve ser alterado para o número da versão sendo lançada.
6. Push para branch:
```bash
git push origin [python-version]
```
7. Publicação do pacote no PyPI (exige usuário e senha):
Para publicar o pacote no PyPI, use:
```bash
poetry version [python-version]
poetry publish --build
```
8. Faz merge da branch para a master
9. Faz release usando a UI do GitHub
10. Atualizar versão do pacote usada internamente
Raw data
{
"_id": null,
"home_page": "https://github.com/base-dos-dados/bases",
"name": "basedosdados",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7.1,<3.11",
"maintainer_email": "",
"keywords": "",
"author": "Joao Carabetta",
"author_email": "joao.carabetta@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f1/01/a3d221e3e0b2566f550dded93b32fc39121439a7be63500f74b6c8f234ec/basedosdados-1.6.11.tar.gz",
"platform": null,
"description": "# Python Package\n\n## Desenvolvimento Linux e Mac: \n\nClone o reposit\u00f3rio principal:\n\n```sh\ngit clone https://github.com/basedosdados/mais.git\n```\nEntre na pasta local do reposit\u00f3rio usando `cd mais/` e suba o ambiente localmente:\n\n```sh\nmake create-env\n. .mais/bin/activate\ncd python-package/\npython setup.py develop\n```\n\n### Desenvolva uma nova feature\n\n1. Abra uma branch com o nome issue-<X>\n2. Fa\u00e7a as modifica\u00e7\u00f5es necess\u00e1rias\n3. Suba o Pull Request apontando para a branch `python-next-minor` ou `python-next-patch`. \n Sendo, minor e patch referentes ao bump da vers\u00e3o: v1.5.7 --> v\\<major>.\\<minor>.\\<patch>.\n4. O nome do PR deve seguir o padr\u00e3o\n `[infra] <titulo explicativo>`\n\n\n### O que uma modifica\u00e7\u00e3o precisa ter\n\n \n- Resolver o problema\n- Lista de modifica\u00e7\u00f5es efetuadas\n 1. Mudei a fun\u00e7\u00e3o X para fazer Y\n 2. Troquei o nome da variavel Z\n- Refer\u00eancia aos issues atendidos\n- Documenta\u00e7\u00e3o e Docstrings\n- Testes\n \n\n## Versionamento\n\n**Para publicar uma nova vers\u00e3o do pacote \u00e9 preciso seguir os seguintes passos:**\n\n1. Fazer o pull da branch:\n\n ```bash\n git pull origin [python-version]\n ```\n \n Onde `[python-version]` \u00e9 a branch da nova vers\u00e3o do pacote.\n\n2. Se necessario adicionar novas depend\u00eancias:\n ```bash\n poetry add <package-name>\n ```\n\n3. Gerar novo `requirements-dev.txt` \n\n ```bash\n poetry export -f requirements.txt --output requirements-dev.txt --without-hashes\n ```\n\n4. Editar `pyproject.toml`:\n\n O arquivo `pyproject.toml` cont\u00e9m, entre outras informa\u00e7\u00f5es, a vers\u00e3o do pacote em python da **BD**. Segue excerto do arquivo:\n\n ```toml\n description = \"Organizar e facilitar o acesso a dados brasileiros atrav\u00e9s de tabelas p\u00fablicas no BigQuery.\"\n homepage = \"https://github.com/base-dos-dados/bases\"\n license = \"MIT\"\n name = \"basedosdados\"\n packages = [\n {include = \"basedosdados\"},\n ]\n readme = \"README.md\"\n repository = \"https://github.com/base-dos-dados/bases\"\n version = \"1.6.1-beta.2\"\n ```\n \n O campo `version` deve ser alterado para o n\u00famero da vers\u00e3o sendo lan\u00e7ada.\n\n5. Editar `basedosdados/__init__.py`:\n \n O arquivo `basedosdados/__init__.py` cont\u00e9m a vers\u00e3o do pacote em python da **BD**. Exemplo:\n \n ```python\n __version__ = \"1.6.1-beta.2\"\n ```\n \n O atributo `__version__` tamb\u00e9m deve ser alterado para o n\u00famero da vers\u00e3o sendo lan\u00e7ada.\n\n6. Push para branch:\n\n ```bash\n git push origin [python-version]\n ```\n\n7. Publica\u00e7\u00e3o do pacote no PyPI (exige usu\u00e1rio e senha):\n Para publicar o pacote no PyPI, use:\n\n ```bash\n poetry version [python-version]\n poetry publish --build\n ```\n8. Faz merge da branch para a master\n9. Faz release usando a UI do GitHub\n10. Atualizar vers\u00e3o do pacote usada internamente\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Organizar e facilitar o acesso a dados brasileiros atrav\u00e9s de tabelas p\u00fablicas no BigQuery.",
"version": "1.6.11",
"project_urls": {
"Homepage": "https://github.com/base-dos-dados/bases",
"Repository": "https://github.com/base-dos-dados/bases"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2110d92e4d854ecd4569d63e48fb92ee68142f8d242a0b0e50e94ae04bc2b9ab",
"md5": "f9cf15af0c04d4d3b7e602f71be650b7",
"sha256": "8d7832eed4a93e3b189a7a5e4aa2f27b57692cb8c0e1f4b11e54543364f84b72"
},
"downloads": -1,
"filename": "basedosdados-1.6.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f9cf15af0c04d4d3b7e602f71be650b7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.1,<3.11",
"size": 51097,
"upload_time": "2023-03-15T23:58:30",
"upload_time_iso_8601": "2023-03-15T23:58:30.670808Z",
"url": "https://files.pythonhosted.org/packages/21/10/d92e4d854ecd4569d63e48fb92ee68142f8d242a0b0e50e94ae04bc2b9ab/basedosdados-1.6.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f101a3d221e3e0b2566f550dded93b32fc39121439a7be63500f74b6c8f234ec",
"md5": "361953606b4dff71b5709c605e43196c",
"sha256": "df913d5513f428af5b3a9be975b4861747b2c60eeb25b279420f5ded1ed7dac8"
},
"downloads": -1,
"filename": "basedosdados-1.6.11.tar.gz",
"has_sig": false,
"md5_digest": "361953606b4dff71b5709c605e43196c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.1,<3.11",
"size": 45164,
"upload_time": "2023-03-15T23:58:32",
"upload_time_iso_8601": "2023-03-15T23:58:32.520011Z",
"url": "https://files.pythonhosted.org/packages/f1/01/a3d221e3e0b2566f550dded93b32fc39121439a7be63500f74b6c8f234ec/basedosdados-1.6.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-15 23:58:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "base-dos-dados",
"github_project": "bases",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "basedosdados"
}
JSON
