# OniDev's Helper Para Consumo das API's
Retorna objeto json da requisição das API's trabalhadas até o momento.
A documentação completa do pacote está disponível em: [Pypi:oni_api](https://pypi.org/project/oni-api/).
## Como testar sua contribuíção antes de enviar uma PR
Primeiramente faça a desinstalação do pacote presente em sua `venv`.
```bash
pip uninstall OniPKG-Api
```
Após a desinstalação, instale o pacote atráves do código fonte modificado.
```bash
pip install -e <path>/OniPKG-Api/
```
Teste a implementação feita em um projeto terceiro ou até mesmo usando os códigos de teste disponíveis. Após testar o código atual faça a desinstalação do pacote novamente.
```bash
pip uninstall OniPKG-Api
```
Após o teste crie sua PR e envie para avaliação.
Se deseja que sua PR vire uma nova release, não se esqueça de mudar no `setup.py` na opção version adicione o nome da
próxima versão proposta para o pacote.
## Como criar uma nova release do projeto
Uma vez que sua contribuição for aprovada via PR você está preparado para criar uma nova release do projeto.
O primeiro passo é criar uma nova tag com base no commit que foi aprovado. Para isso na branch master execute o comando:
```bash
git tag -a <tag_name> -m "<comentário descritivo da tag>"
```
Exemplos de `tag_name`: `v1.2`, `v1.2.3` ou `v1.2-beta`
Com a tag criada faça o seu envio para o repositório no `GitHub`.
```bash
git push origin <tag_name>
```
Com a tag enviada podemos seguir para a criação de uma release.
Essa pode ser criada diretamente pelo github com os seguintes passos:
- Vá no repositório do projeto no GitHub na aba Code.
- Acesse o menu Releases presente, normalmente, no lado direito.
- Clique na opção Tags para ver a listagem de tags.
- Clique nos três pontinhos a direita na tag que você acabou de criar.
- Selecione a opção create release.
- Adicione um nome na release (pode ser o mesmo nome da tag) e uma descrição para as novas features da tag.
Raw data
{
"_id": null,
"home_page": "https://github.com/LucasHeilbuth",
"name": "OniPKG-Api",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "onimusic",
"author": "Lucas Heilbuth Nazareth de Sousa",
"author_email": "lucasheilbuth@yahoo.com.br",
"download_url": "https://files.pythonhosted.org/packages/1f/38/63945022df571c44d62058e70bd1634507d47a34a1b4a391e76e43fa6725/OniPKG-Api-1.0.13.tar.gz",
"platform": null,
"description": "# OniDev's Helper Para Consumo das API's\n\nRetorna objeto json da requisi\u00e7\u00e3o das API's trabalhadas at\u00e9 o momento.\n\nA documenta\u00e7\u00e3o completa do pacote est\u00e1 dispon\u00edvel em: [Pypi:oni_api](https://pypi.org/project/oni-api/).\n\n## Como testar sua contribu\u00ed\u00e7\u00e3o antes de enviar uma PR\nPrimeiramente fa\u00e7a a desinstala\u00e7\u00e3o do pacote presente em sua `venv`.\n\n```bash\npip uninstall OniPKG-Api\n```\n\nAp\u00f3s a desinstala\u00e7\u00e3o, instale o pacote atr\u00e1ves do c\u00f3digo fonte modificado.\n\n```bash\npip install -e <path>/OniPKG-Api/\n```\n\nTeste a implementa\u00e7\u00e3o feita em um projeto terceiro ou at\u00e9 mesmo usando os c\u00f3digos de teste dispon\u00edveis. Ap\u00f3s testar o c\u00f3digo atual fa\u00e7a a desinstala\u00e7\u00e3o do pacote novamente.\n\n```bash\npip uninstall OniPKG-Api\n```\n\nAp\u00f3s o teste crie sua PR e envie para avalia\u00e7\u00e3o.\nSe deseja que sua PR vire uma nova release, n\u00e3o se esque\u00e7a de mudar no `setup.py` na op\u00e7\u00e3o version adicione o nome da\npr\u00f3xima vers\u00e3o proposta para o pacote.\n\n## Como criar uma nova release do projeto\nUma vez que sua contribui\u00e7\u00e3o for aprovada via PR voc\u00ea est\u00e1 preparado para criar uma nova release do projeto.\n\nO primeiro passo \u00e9 criar uma nova tag com base no commit que foi aprovado. Para isso na branch master execute o comando:\n\n```bash\ngit tag -a <tag_name> -m \"<coment\u00e1rio descritivo da tag>\"\n```\n\nExemplos de `tag_name`: `v1.2`, `v1.2.3` ou `v1.2-beta`\n\nCom a tag criada fa\u00e7a o seu envio para o reposit\u00f3rio no `GitHub`.\n\n```bash\ngit push origin <tag_name>\n```\n\nCom a tag enviada podemos seguir para a cria\u00e7\u00e3o de uma release.\nEssa pode ser criada diretamente pelo github com os seguintes passos:\n - V\u00e1 no reposit\u00f3rio do projeto no GitHub na aba Code.\n - Acesse o menu Releases presente, normalmente, no lado direito.\n - Clique na op\u00e7\u00e3o Tags para ver a listagem de tags.\n - Clique nos tr\u00eas pontinhos a direita na tag que voc\u00ea acabou de criar.\n - Selecione a op\u00e7\u00e3o create release.\n - Adicione um nome na release (pode ser o mesmo nome da tag) e uma descri\u00e7\u00e3o para as novas features da tag.\n",
"bugtrack_url": null,
"license": "",
"summary": "Helper para consumo de APIs",
"version": "1.0.13",
"split_keywords": [
"onimusic"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ac8918187f11fd6764230d2ce29b808c4b8c36ba7f6b84519ccb87aea21e7c83",
"md5": "fee94ab81a322e18cd51c0348b34584a",
"sha256": "4836de9bf408ff00a48a293a7932d4a2ae49ed7f4ef30ff67add21d9870dd696"
},
"downloads": -1,
"filename": "OniPKG_Api-1.0.13-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fee94ab81a322e18cd51c0348b34584a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 11385,
"upload_time": "2023-01-16T12:31:42",
"upload_time_iso_8601": "2023-01-16T12:31:42.832741Z",
"url": "https://files.pythonhosted.org/packages/ac/89/18187f11fd6764230d2ce29b808c4b8c36ba7f6b84519ccb87aea21e7c83/OniPKG_Api-1.0.13-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1f3863945022df571c44d62058e70bd1634507d47a34a1b4a391e76e43fa6725",
"md5": "b00b63727f63359923037e4d969a4261",
"sha256": "4ac4283e06a5cc9c8aa6c42508432f2dbc40d78d4fe847d0ad24691323c7211c"
},
"downloads": -1,
"filename": "OniPKG-Api-1.0.13.tar.gz",
"has_sig": false,
"md5_digest": "b00b63727f63359923037e4d969a4261",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10815,
"upload_time": "2023-01-16T12:31:46",
"upload_time_iso_8601": "2023-01-16T12:31:46.285706Z",
"url": "https://files.pythonhosted.org/packages/1f/38/63945022df571c44d62058e70bd1634507d47a34a1b4a391e76e43fa6725/OniPKG-Api-1.0.13.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-16 12:31:46",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "onipkg-api"
}
JSON