# Feriados Brasileiros
[PyPI](https://pypi.org/project/feriados-brasileiros) | [GitHub](https://github.com/michelmetran/feriados)
<br>
> _Adoro um feriado! Quem não gosta?!_
Com objetivo de listar os feriados brasileiros, criei o pacote **feriados-brasileiros**, que permite criar uma tabela contendo todos os feriados de um determinado ano, bem como ajustar atributos conforme a necessidade.
A opção por ajustar atributos se deve ao fato de que, nem sempre, um feriado em uma instituição também é feriado n'outra! Feriado de endoeças, por exemplo, é feriado em instituições do meio jurídico, enquanto muitos nem sabem que feriado é esse!
É possível ajustar o nome dos feriados e até mesmo um campo de observações!
<br>
---
## Como Instalar?!
```python
pip3 install feriados-brasileiros
```
<br>
---
## Como Usar?!
A maneira mais simples é obter todos os feriados para um determinado ano. Dessa forma os atributos serão definidos por padrão.
```python
from feriados_brasileiros import datas
# Adiciona todos os feriados de um determinado ano
feriados = datas.Feriados(ano=2023)
feriados.add_all()
feriados
```
<br>
---
## Detalhes
É possível usar a ferramenta de uma maneira mais customizada, onde é possível ajustar todos os atributos para cada um dos feriados.
Dentre os atributos existentes estão:
- `nome_alternativo`: Nome do Feriado;
- `feriado`: Indica se é feriado ou apenas uma data que usualmente "enforca-se", porém não é feriado formalmente (exemplo: véspera de natal e quarta-feira de cinzas);
- `obs`: Campo para observações quaisquer;
```python
from feriados_brasileiros import datas
# Adiciona apenas um feriado de um determinado ano
feriados = datas.Feriados(ano=2023)
feriados.add(nome='Sexta-feira Santa', nome_alternativo='Paixão de Cristo', obs='Também conhecido como Sexta-feira Santa')
feriados
```
<br>
---
## Remoção
É possível remover feriados específicos, após ter adicionado todos!
```python
from feriados_brasileiros import datas
# Adiciona todos os feriados de um determinado ano
feriados = datas.Feriados(ano=2023)
feriados.add_all()
feriados.remove('Domingo de Ramos')
feriados.remove('Endoenças')
feriados
```
<br>
---
## _Custom_
Também é possível adicionar um feriado customizado.
```python
from feriados_brasileiros import datas
# Adiciona todos os feriados de um determinado ano, além de outras feriados customizados (municipais e estaduais, por exemplo)
feriados = datas.Feriados(ano=2023)
feriados.add_all()
feriados.add_custom(
nome='Dia do Servidor Público',
mes=10,
dia=28,
feriado=True,
tipo='Fixo',
)
feriados
```
<br>
---
## Resultados
Seja qual for a opção escolhida para usar o programa, os resultados podem ser obtidos de duas formas distintas.
```python
# Resultado em Lista
lista_feriados = feriados.create_list(tipo='datetime')
print(lista_feriados)
# Resultado em Tabela (mais informações)
df_feriados = feriados.create_table()
print(df_feriados.head())
```
<br>
---
## Documentação
- [UFRGS: **Cálculo do Dia da Páscoa**](https://www.inf.ufrgs.br/~cabral/Pascoa.html)
- [Problemas e Teoremas: **Script em Python do algoritmo de O’Beirne para calcular a data da Páscoa**](https://problemasteoremas.wordpress.com/2010/02/17/script-em-python-do-algoritmo-de-obeirne-para-calcular-o-dia-e-o-mes-do-domingo-de-pascoa/)
- [YouTube: **Problemas em Python 05 - Cálculo de Datas Móveis**](https://www.youtube.com/watch?v=wbM7YhfcSqs), de Fernando Anselmo. Metodologia que adotei para calcular os feriados móveis nesse projeto.
<br>
---
## _TODO_
1. ~~Ajustar documentação~~
2. ~~Incluir o dia da semana!~~
3. ~~Implantar classe Calendário para pegar feriados de anos diversos~~
4. ~~Add domingo de ramos~~
Raw data
{
"_id": null,
"home_page": "https://github.com/michelmetran/feriados",
"name": "feriados-brasileiros",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": "",
"keywords": "python,datas,feriados",
"author": "Michel Metran",
"author_email": "michelmetran@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/15/bf/aa069dd3e2b15fe5029f6040fa05f24af1408ee1e388096b37bc88d30b3f/feriados_brasileiros-0.0.7.tar.gz",
"platform": null,
"description": "# Feriados Brasileiros\n\n[PyPI](https://pypi.org/project/feriados-brasileiros) | [GitHub](https://github.com/michelmetran/feriados)\n\n<br>\n\n> _Adoro um feriado! Quem n\u00e3o gosta?!_\n\nCom objetivo de listar os feriados brasileiros, criei o pacote **feriados-brasileiros**, que permite criar uma tabela contendo todos os feriados de um determinado ano, bem como ajustar atributos conforme a necessidade.\n\nA op\u00e7\u00e3o por ajustar atributos se deve ao fato de que, nem sempre, um feriado em uma institui\u00e7\u00e3o tamb\u00e9m \u00e9 feriado n'outra! Feriado de endoe\u00e7as, por exemplo, \u00e9 feriado em institui\u00e7\u00f5es do meio jur\u00eddico, enquanto muitos nem sabem que feriado \u00e9 esse!\n\n\u00c9 poss\u00edvel ajustar o nome dos feriados e at\u00e9 mesmo um campo de observa\u00e7\u00f5es!\n\n<br>\n\n---\n\n## Como Instalar?!\n\n```python\npip3 install feriados-brasileiros\n```\n\n<br>\n\n---\n\n## Como Usar?!\n\nA maneira mais simples \u00e9 obter todos os feriados para um determinado ano. Dessa forma os atributos ser\u00e3o definidos por padr\u00e3o.\n\n```python\nfrom feriados_brasileiros import datas\n\n# Adiciona todos os feriados de um determinado ano\nferiados = datas.Feriados(ano=2023)\nferiados.add_all()\nferiados\n```\n\n<br>\n\n---\n\n## Detalhes\n\n\u00c9 poss\u00edvel usar a ferramenta de uma maneira mais customizada, onde \u00e9 poss\u00edvel ajustar todos os atributos para cada um dos feriados.\n\nDentre os atributos existentes est\u00e3o:\n\n- `nome_alternativo`: Nome do Feriado;\n- `feriado`: Indica se \u00e9 feriado ou apenas uma data que usualmente \"enforca-se\", por\u00e9m n\u00e3o \u00e9 feriado formalmente (exemplo: v\u00e9spera de natal e quarta-feira de cinzas);\n- `obs`: Campo para observa\u00e7\u00f5es quaisquer;\n\n```python\nfrom feriados_brasileiros import datas\n\n# Adiciona apenas um feriado de um determinado ano\nferiados = datas.Feriados(ano=2023)\nferiados.add(nome='Sexta-feira Santa', nome_alternativo='Paix\u00e3o de Cristo', obs='Tamb\u00e9m conhecido como Sexta-feira Santa')\nferiados\n```\n\n<br>\n\n---\n\n## Remo\u00e7\u00e3o\n\n\u00c9 poss\u00edvel remover feriados espec\u00edficos, ap\u00f3s ter adicionado todos!\n\n```python\nfrom feriados_brasileiros import datas\n\n# Adiciona todos os feriados de um determinado ano\nferiados = datas.Feriados(ano=2023)\nferiados.add_all()\nferiados.remove('Domingo de Ramos')\nferiados.remove('Endoen\u00e7as')\nferiados\n```\n\n<br>\n\n---\n\n## _Custom_\n\nTamb\u00e9m \u00e9 poss\u00edvel adicionar um feriado customizado.\n\n```python\nfrom feriados_brasileiros import datas\n\n# Adiciona todos os feriados de um determinado ano, al\u00e9m de outras feriados customizados (municipais e estaduais, por exemplo)\nferiados = datas.Feriados(ano=2023)\nferiados.add_all()\nferiados.add_custom(\n nome='Dia do Servidor P\u00fablico',\n mes=10,\n dia=28,\n feriado=True,\n tipo='Fixo',\n)\nferiados\n```\n\n<br>\n\n---\n\n## Resultados\n\nSeja qual for a op\u00e7\u00e3o escolhida para usar o programa, os resultados podem ser obtidos de duas formas distintas.\n\n```python\n# Resultado em Lista\nlista_feriados = feriados.create_list(tipo='datetime')\nprint(lista_feriados)\n\n# Resultado em Tabela (mais informa\u00e7\u00f5es)\ndf_feriados = feriados.create_table()\nprint(df_feriados.head())\n```\n\n<br>\n\n---\n\n## Documenta\u00e7\u00e3o\n\n- [UFRGS: **C\u00e1lculo do Dia da P\u00e1scoa**](https://www.inf.ufrgs.br/~cabral/Pascoa.html)\n- [Problemas e Teoremas: **Script em Python do algoritmo de O\u2019Beirne para calcular a data da P\u00e1scoa**](https://problemasteoremas.wordpress.com/2010/02/17/script-em-python-do-algoritmo-de-obeirne-para-calcular-o-dia-e-o-mes-do-domingo-de-pascoa/)\n- [YouTube: **Problemas em Python 05 - C\u00e1lculo de Datas M\u00f3veis**](https://www.youtube.com/watch?v=wbM7YhfcSqs), de Fernando Anselmo. Metodologia que adotei para calcular os feriados m\u00f3veis nesse projeto.\n\n<br>\n\n---\n\n## _TODO_\n\n1. ~~Ajustar documenta\u00e7\u00e3o~~\n2. ~~Incluir o dia da semana!~~\n3. ~~Implantar classe Calend\u00e1rio para pegar feriados de anos diversos~~\n4. ~~Add domingo de ramos~~\n",
"bugtrack_url": null,
"license": "",
"summary": "Feriados Brasileiros",
"version": "0.0.7",
"project_urls": {
"Homepage": "https://github.com/michelmetran/feriados"
},
"split_keywords": [
"python",
"datas",
"feriados"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "96dc250cfaec8d5ecc9b1d8161b2c831ace59b16e68c982fcd0e938ad9993745",
"md5": "ba57836570b4d7c53ba0d92fc8ca54db",
"sha256": "0425d369698a47bba0b3f7927d1c79e70bd7a2e49fe395cee1435d9ea31051c4"
},
"downloads": -1,
"filename": "feriados_brasileiros-0.0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ba57836570b4d7c53ba0d92fc8ca54db",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 7870,
"upload_time": "2023-07-27T00:37:53",
"upload_time_iso_8601": "2023-07-27T00:37:53.287448Z",
"url": "https://files.pythonhosted.org/packages/96/dc/250cfaec8d5ecc9b1d8161b2c831ace59b16e68c982fcd0e938ad9993745/feriados_brasileiros-0.0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "15bfaa069dd3e2b15fe5029f6040fa05f24af1408ee1e388096b37bc88d30b3f",
"md5": "76f91d0a41029da785ea2d005d8b6b5f",
"sha256": "e5787e06043fe5e4c8e1de73e81e077a700651fe7ac872487f55ab870bcc7d6c"
},
"downloads": -1,
"filename": "feriados_brasileiros-0.0.7.tar.gz",
"has_sig": false,
"md5_digest": "76f91d0a41029da785ea2d005d8b6b5f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 8243,
"upload_time": "2023-07-27T00:37:54",
"upload_time_iso_8601": "2023-07-27T00:37:54.569603Z",
"url": "https://files.pythonhosted.org/packages/15/bf/aa069dd3e2b15fe5029f6040fa05f24af1408ee1e388096b37bc88d30b3f/feriados_brasileiros-0.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-27 00:37:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "michelmetran",
"github_project": "feriados",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "feriados-brasileiros"
}
JSON
