# Modularizador
For explanations in english, scroll down *(Explicações em inglês no final)*.
Instale com
> !pip install modularizador
Após importado no Jupyter Notebook, permite importar arquivos .ipynb como se fossem arquivos .py, inclusive os que estão em subpastas.
Exemplo de uso:
1. Na pasta do seu projeto, use seu Jupyter Notebook para criar o arquivo main.ipynb, depois crie um arquivo chamado **somador.ipynb** e coloque ele dentro de uma subpasta chamada **pacotes**.
```
'----Pasta do seu projeto
| main.ipynb
|
'---pacotes
somador.ipynb
```
2. Crie uma função chamada soma dentro do arquivo somador.ipynb:
```python
def soma(a, b):
return a + b
```
3. Agora, a partir de main.ipynb, é só importar o modularizador e você poderá importar também o somador.ipynb:
```python
import modularizador
from pacotes import somador
somador.soma(2, 3)
>>> 5
```
O código utilizado nesta biblioteca para obter o resultado acima foi extraído [desta página](https://jupyter-notebook.readthedocs.io/en/stable/examples/Notebook/Importing%20Notebooks.html) da documentação do Jupyter Notebook.
Daqui para baixo vamos nos referir a ele como *o script*, ou como *modularizador.py*.
---
A biblioteca modularizador conta ainda com 3 funções úteis: **ativa()**, **desativa()** e **status_startup()**.
* ##### ativa()
```python
import modularizador
modularizador.ativa()
```
Insere *o script* na pasta startup do ipython, tornando desnecessário importar a biblioteca modularizador a partir das próximas vezes que você abrir um projeto. O efeito durará enquanto *modularizador.py* estiver na pasta startup, portanto fechar seu Jupyter Notebook não o desfará.
No exemplo anterior, se você já tivesse, em algum momento do passado, realizado o procedimento de ativação logo acima, poderia, em seu novo projeto, importar pacotes/somador.ipynb sem a necessidade de importar o modularizador. Simplesmente assim:
```python
from pacotes import somador
somador.soma(2, 3)
>>> 5
```
* ##### desativa()
```python
import modularizador
modularizador.desativa()
```
Remove *o script modularizador.py* da pasta startup do ipyton, tirando do seu Jupyter Notebook a capacidade de importar arquivos .ipynb sem importar manualmente o modularizador em cada projeto.
* ##### status_startup()
```python
import modularizador
modularizador.status_startup()
```
Apenas informa se *o script modularizador.py* está na pasta startup do ipyton. I.e., se está ou não ativo o recurso que permite a importação de arquivos .ipynb sem a necessidade de importar a biblioteca modularizador explicitamente em cada projeto.
É só isso. Abaixo estão as mesmas explicações acima em inglês.
---
---
---
---
---
## == Explanations in english ==
Install with
> !pip install modularizador
After importing modularizador on Jupyter Notebook, you'll be able to import .ipynb files as if they were .py files, even those inside subfolders.
Usage example:
1. Inside your project directory, use your Jupyter Notebook to create main.ipynb, then create **summer.ipynb** and put it inside a subfolder named **packages**.
```
'----Your project folder
| main.ipynb
|
'---packages
summer.ipynb
```
2. Define a function named add inside summer.ipynb:
```python
def add(a, b):
return a + b
```
3. Now, inside main.ipynb, import modularizador and you'll become able to import summer.ipynb too afterwards:
```python
import modularizador
from packages import summer
summer.add(2, 3)
>>> 5
```
The code that makes this possible was extracted from [this page](https://jupyter-notebook.readthedocs.io/en/stable/examples/Notebook/Importing%20Notebooks.html) of Jupyter Notebook's documentation.
From now on, we will refer to it either as *the script* or as *modularizador.py*.
---
The modularizador library has 3 useful methods: **ativa()**, **desativa()** and **status_startup()**.
* ##### ativa()
```python
import modularizador
modularizador.ativa()
```
Ativa means activate. This method inserts *the script* in ipython's startup, making it unnecessary to explicitly import modularizador everytime you open a new Jupyter Notebook project from now on. This effect will last as long as *modularizador.py* remains in the startup folder, so closing your Jupyter Notebook won't undo it.
In our last example, had you activated modularizador somewhen in the past, you would be able to import packages/summer.ipynb without having to import modularizador first. Just like:
```python
from packages import summer
summer.add(2, 3)
>>> 5
```
* ##### desativa()
```python
import modularizador
modularizador.desativa()
```
Desativa means deactivate. This method removes *the script (modularizador.py)* from ipython's startup folder, making your Jupyter Notebook unable to import .ipynb without manually importing modularizador priorly in each project again.
* ##### status_startup()
```python
import modularizador
modularizador.status_startup()
```
Just tells you whether or not *the script (modularizador.py)* is in ipython's startup folder. I.e., whether modularizador is active and hence allowing you to import .ipynb without the need to explicitly import modularizador beforehand in your projects or not.
Raw data
{
"_id": null,
"home_page": "",
"name": "modularizador",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "m\u00f3dulos ipynb jupyter notebook py importar importa\u00e7\u00e3o import importation importing modules ipython",
"author": "Heitor Leal Farnese",
"author_email": "heitor.leal.farnese@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/05/dd/4df6eddd6b9d52334d438960f4ff514a921ec1d5b2a0b550708016ed92c1/modularizador-1.0.13.tar.gz",
"platform": null,
"description": "# Modularizador\r\nFor explanations in english, scroll down *(Explicações em inglês no final)*.\r\n\r\nInstale com\r\n> !pip install modularizador\r\n\r\nApós importado no Jupyter Notebook, permite importar arquivos .ipynb como se fossem arquivos .py, inclusive os que estão em subpastas.\r\n\r\nExemplo de uso:\r\n1. Na pasta do seu projeto, use seu Jupyter Notebook para criar o arquivo main.ipynb, depois crie um arquivo chamado **somador.ipynb** e coloque ele dentro de uma subpasta chamada **pacotes**.\r\n```\r\n'----Pasta do seu projeto\r\n | main.ipynb\r\n |\r\n '---pacotes\r\n somador.ipynb\r\n```\r\n2. Crie uma função chamada soma dentro do arquivo somador.ipynb:\r\n\r\n```python\r\ndef soma(a, b):\r\n return a + b\r\n```\r\n3. Agora, a partir de main.ipynb, é só importar o modularizador e você poderá importar também o somador.ipynb:\r\n\r\n```python\r\nimport modularizador\r\nfrom pacotes import somador\r\nsomador.soma(2, 3)\r\n>>> 5\r\n```\r\n\r\nO código utilizado nesta biblioteca para obter o resultado acima foi extraído [desta página](https://jupyter-notebook.readthedocs.io/en/stable/examples/Notebook/Importing%20Notebooks.html) da documentação do Jupyter Notebook. \r\nDaqui para baixo vamos nos referir a ele como *o script*, ou como *modularizador.py*.\r\n---\r\nA biblioteca modularizador conta ainda com 3 funções úteis: **ativa()**, **desativa()** e **status_startup()**.\r\n* ##### ativa()\r\n\r\n```python\r\nimport modularizador\r\nmodularizador.ativa()\r\n```\r\nInsere *o script* na pasta startup do ipython, tornando desnecessário importar a biblioteca modularizador a partir das próximas vezes que você abrir um projeto. O efeito durará enquanto *modularizador.py* estiver na pasta startup, portanto fechar seu Jupyter Notebook não o desfará. \r\n\r\nNo exemplo anterior, se você já tivesse, em algum momento do passado, realizado o procedimento de ativação logo acima, poderia, em seu novo projeto, importar pacotes/somador.ipynb sem a necessidade de importar o modularizador. Simplesmente assim:\r\n```python\r\nfrom pacotes import somador\r\nsomador.soma(2, 3)\r\n>>> 5\r\n```\r\n* ##### desativa()\r\n```python\r\nimport modularizador\r\nmodularizador.desativa()\r\n```\r\nRemove *o script modularizador.py* da pasta startup do ipyton, tirando do seu Jupyter Notebook a capacidade de importar arquivos .ipynb sem importar manualmente o modularizador em cada projeto.\r\n\r\n* ##### status_startup()\r\n```python\r\nimport modularizador\r\nmodularizador.status_startup()\r\n```\r\nApenas informa se *o script modularizador.py* está na pasta startup do ipyton. I.e., se está ou não ativo o recurso que permite a importação de arquivos .ipynb sem a necessidade de importar a biblioteca modularizador explicitamente em cada projeto.\r\n\r\nÉ só isso. Abaixo estão as mesmas explicações acima em inglês.\r\n\r\n---\r\n---\r\n---\r\n---\r\n---\r\n## == Explanations in english ==\r\n\r\nInstall with\r\n> !pip install modularizador\r\n\r\nAfter importing modularizador on Jupyter Notebook, you'll be able to import .ipynb files as if they were .py files, even those inside subfolders.\r\n\r\nUsage example:\r\n1. Inside your project directory, use your Jupyter Notebook to create main.ipynb, then create **summer.ipynb** and put it inside a subfolder named **packages**.\r\n```\r\n'----Your project folder\r\n | main.ipynb\r\n |\r\n '---packages\r\n summer.ipynb\r\n```\r\n2. Define a function named add inside summer.ipynb:\r\n\r\n```python\r\ndef add(a, b):\r\n return a + b\r\n```\r\n3. Now, inside main.ipynb, import modularizador and you'll become able to import summer.ipynb too afterwards:\r\n\r\n```python\r\nimport modularizador\r\nfrom packages import summer\r\nsummer.add(2, 3)\r\n>>> 5\r\n```\r\n\r\nThe code that makes this possible was extracted from [this page](https://jupyter-notebook.readthedocs.io/en/stable/examples/Notebook/Importing%20Notebooks.html) of Jupyter Notebook's documentation. \r\nFrom now on, we will refer to it either as *the script* or as *modularizador.py*.\r\n---\r\nThe modularizador library has 3 useful methods: **ativa()**, **desativa()** and **status_startup()**.\r\n* ##### ativa()\r\n\r\n```python\r\nimport modularizador\r\nmodularizador.ativa()\r\n```\r\nAtiva means activate. This method inserts *the script* in ipython's startup, making it unnecessary to explicitly import modularizador everytime you open a new Jupyter Notebook project from now on. This effect will last as long as *modularizador.py* remains in the startup folder, so closing your Jupyter Notebook won't undo it. \r\n\r\nIn our last example, had you activated modularizador somewhen in the past, you would be able to import packages/summer.ipynb without having to import modularizador first. Just like:\r\n```python\r\nfrom packages import summer\r\nsummer.add(2, 3)\r\n>>> 5\r\n```\r\n* ##### desativa()\r\n```python\r\nimport modularizador\r\nmodularizador.desativa()\r\n```\r\nDesativa means deactivate. This method removes *the script (modularizador.py)* from ipython's startup folder, making your Jupyter Notebook unable to import .ipynb without manually importing modularizador priorly in each project again.\r\n\r\n* ##### status_startup()\r\n```python\r\nimport modularizador\r\nmodularizador.status_startup()\r\n```\r\nJust tells you whether or not *the script (modularizador.py)* is in ipython's startup folder. I.e., whether modularizador is active and hence allowing you to import .ipynb without the need to explicitly import modularizador beforehand in your projects or not.\r\n",
"bugtrack_url": null,
"license": "",
"summary": "Importe arquivos .ipynb como se fossem arquivos .py no Jupyter Notebook /\\/\\/\\ Import .ipynb files as if they were .py files on Jupyter Notebook",
"version": "1.0.13",
"split_keywords": [
"m\u00f3dulos",
"ipynb",
"jupyter",
"notebook",
"py",
"importar",
"importa\u00e7\u00e3o",
"import",
"importation",
"importing",
"modules",
"ipython"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "5160289d5177c3ba72e73c057ee5a522",
"sha256": "a3df7e26a56dbe7fb4f53ef2e66c20e7be22f904788aff4be915ea5006ee27e1"
},
"downloads": -1,
"filename": "modularizador-1.0.13-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5160289d5177c3ba72e73c057ee5a522",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8625,
"upload_time": "2022-12-03T16:12:21",
"upload_time_iso_8601": "2022-12-03T16:12:21.760163Z",
"url": "https://files.pythonhosted.org/packages/4c/16/09b0c1262b06bd0756a347e4931fc42739838e608266390b3fd8cd32f36b/modularizador-1.0.13-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "9747be17cd3bf0df37742cbd1a08fd6f",
"sha256": "8ed34d6a4e400afcd5460abdc94946911426681bf85760129204dd0a9847ee19"
},
"downloads": -1,
"filename": "modularizador-1.0.13.tar.gz",
"has_sig": false,
"md5_digest": "9747be17cd3bf0df37742cbd1a08fd6f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5956,
"upload_time": "2022-12-03T16:12:24",
"upload_time_iso_8601": "2022-12-03T16:12:24.358581Z",
"url": "https://files.pythonhosted.org/packages/05/dd/4df6eddd6b9d52334d438960f4ff514a921ec1d5b2a0b550708016ed92c1/modularizador-1.0.13.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-03 16:12:24",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "modularizador"
}
JSON