# notebook-ed
A tool to convert `.py` files to `.ipynb` files and delete the original `.py` files. This tool makes it easy to convert Python scripts into Jupyter Notebooks for easy sharing and collaboration.
If you find `notebook-ed` useful, please consider giving it a star on GitHub! Your support helps me to continue developing and improving this tool.
[](https://pypi.org/project/notebook-ed/0.1.2/)
[](https://github.com/w3cdpass/notebook-ed/stargazers)
## Project Insights
`notebook-ed` is designed to streamline the process of converting Python scripts into Jupyter Notebooks. It is particularly useful for educators, data scientists, and developers who need to present their Python code in a more interactive format.
### Features
- Converts `.py` files to `.ipynb` files
- Deletes the original `.py` files after conversion
- Processes directories to batch convert multiple files
- Simple command-line interface for ease of use
## How to Start with Source Code
To start using `notebook-ed`, follow these steps:
1. **Clone the Repository**
```sh
git clone https://github.com/w3cdpass/notebook-ed.git
cd notebook-ed
```
2. **Create a Virtual Environment**
```sh
python -m venv notebook_ed_env
```
3. **Activate the Virtual Environment**
- On Windows:
```sh
notebook_ed_env\Scripts\activate
```
- On macOS/Linux:
```sh
source notebook_ed_env/bin/activate
```
4. **Install Dependencies**
```sh
pip install -r requirements.txt
```
5. **Run the Script**
```sh
notebook-ed -r <root_directory> # To convert all .py files in a directory
notebook-ed -f <file_path> # To convert a single .py file
```
## How to Contribute
We welcome contributions to `notebook-ed`! If you have ideas for improvements or have found bugs, please follow these steps to contribute:
1. **Fork the Repository**
Click the "Fork" button at the top right corner of this repository page.
2. **Clone Your Fork**
```sh
git clone https://github.com/<your-username>/notebook-ed.git
cd notebook-ed
```
3. **Create a New Branch**
```sh
git checkout -b your-branch-name
```
4. **Make Your Changes**
Make your changes to the codebase and ensure that all tests pass.
5. **Commit Your Changes**
```sh
git add .
git commit -m "Description of your changes"
```
6. **Push to Your Fork**
```sh
git push origin your-branch-name
```
7. **Create a Pull Request**
Go to the original repository and create a pull request with a description of your changes.
## Contact
For any queries, feel free to contact me at [kupasva663@gmail.com](mailto:kupasva663@gmail.com).
Raw data
{
"_id": null,
"home_page": "https://github.com/w3cdpass/notebook-ed.git",
"name": "notebook-ed",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "python, converter, notebook, jupyter, py2nb, ipynb, automation, development, tools",
"author": "w3cdpass",
"author_email": "w3cdpass <kupasva663@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/1d/f7/e08b26c0bf2cf422e0f9acf1f236717af3431ede7242aeb23b4bdff5f17d/notebook_ed-0.1.4.tar.gz",
"platform": null,
"description": "# notebook-ed\n\nA tool to convert `.py` files to `.ipynb` files and delete the original `.py` files. This tool makes it easy to convert Python scripts into Jupyter Notebooks for easy sharing and collaboration.\n\nIf you find `notebook-ed` useful, please consider giving it a star on GitHub! Your support helps me to continue developing and improving this tool.\n\n\n[](https://pypi.org/project/notebook-ed/0.1.2/)\n[](https://github.com/w3cdpass/notebook-ed/stargazers)\n\n## Project Insights\n\n`notebook-ed` is designed to streamline the process of converting Python scripts into Jupyter Notebooks. It is particularly useful for educators, data scientists, and developers who need to present their Python code in a more interactive format. \n\n### Features\n\n- Converts `.py` files to `.ipynb` files\n- Deletes the original `.py` files after conversion\n- Processes directories to batch convert multiple files\n- Simple command-line interface for ease of use\n\n## How to Start with Source Code\n\nTo start using `notebook-ed`, follow these steps:\n\n1. **Clone the Repository**\n\n ```sh\n git clone https://github.com/w3cdpass/notebook-ed.git\n cd notebook-ed\n ```\n\n2. **Create a Virtual Environment**\n\n ```sh\n python -m venv notebook_ed_env\n ```\n\n3. **Activate the Virtual Environment**\n\n - On Windows:\n ```sh\n notebook_ed_env\\Scripts\\activate\n ```\n - On macOS/Linux:\n ```sh\n source notebook_ed_env/bin/activate\n ```\n\n4. **Install Dependencies**\n\n ```sh\n pip install -r requirements.txt\n ```\n\n5. **Run the Script**\n\n ```sh\n notebook-ed -r <root_directory> # To convert all .py files in a directory\n notebook-ed -f <file_path> # To convert a single .py file\n ```\n\n## How to Contribute\n\nWe welcome contributions to `notebook-ed`! If you have ideas for improvements or have found bugs, please follow these steps to contribute:\n\n1. **Fork the Repository**\n\n Click the \"Fork\" button at the top right corner of this repository page.\n\n2. **Clone Your Fork**\n\n ```sh\n git clone https://github.com/<your-username>/notebook-ed.git\n cd notebook-ed\n ```\n\n3. **Create a New Branch**\n\n ```sh\n git checkout -b your-branch-name\n ```\n\n4. **Make Your Changes**\n\n Make your changes to the codebase and ensure that all tests pass.\n\n5. **Commit Your Changes**\n\n ```sh\n git add .\n git commit -m \"Description of your changes\"\n ```\n\n6. **Push to Your Fork**\n\n ```sh\n git push origin your-branch-name\n ```\n\n7. **Create a Pull Request**\n\n Go to the original repository and create a pull request with a description of your changes.\n\n## Contact\n\nFor any queries, feel free to contact me at [kupasva663@gmail.com](mailto:kupasva663@gmail.com).\n",
"bugtrack_url": null,
"license": "# License This is a simple and permissive license for the `py2nb` project. This license allows contributors to modify and distribute the project under the following terms: ## Permissions - Modification: Contributors are allowed to modify the project. - Distribution: Contributors are allowed to distribute the project. ## Conditions - Attribution: Contributors must give appropriate credit, provide a link to the license, and indicate if changes were made. - Permission: Contributors must obtain explicit permission from the original author (you) to make changes to the project. ## Limitation - Liability: This license does not hold the original author liable for any damages arising from the use of the project. - Warranty: This license does not include any warranties of any kind. --- By contributing to this project, you agree to these terms. ",
"summary": "A tool to convert .py files to .ipynb",
"version": "0.1.4",
"project_urls": {
"Bug Tracker": "https://github.com/w3cdpass/notebook-ed/issues",
"Homepage": "https://github.com/w3cdpass/notebook-ed"
},
"split_keywords": [
"python",
" converter",
" notebook",
" jupyter",
" py2nb",
" ipynb",
" automation",
" development",
" tools"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6a854fcc47c2d0c454a045c8a619143b8e711057f2fafbee2bb54d807b4a0d7a",
"md5": "f39a194afdfce31f38af8c75f094b1e2",
"sha256": "06da5e211a5acee098f4e0dcb0d75bbdc4118b4b59654817a718bff748c2a642"
},
"downloads": -1,
"filename": "notebook_ed-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f39a194afdfce31f38af8c75f094b1e2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 7032,
"upload_time": "2024-07-31T05:20:32",
"upload_time_iso_8601": "2024-07-31T05:20:32.716349Z",
"url": "https://files.pythonhosted.org/packages/6a/85/4fcc47c2d0c454a045c8a619143b8e711057f2fafbee2bb54d807b4a0d7a/notebook_ed-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1df7e08b26c0bf2cf422e0f9acf1f236717af3431ede7242aeb23b4bdff5f17d",
"md5": "99f2c78a1b7505d02f91c155a9a24309",
"sha256": "79124d985c5afd61a9b905bcadab92190db8c03a86c59674ec562723000a9b2f"
},
"downloads": -1,
"filename": "notebook_ed-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "99f2c78a1b7505d02f91c155a9a24309",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 6382,
"upload_time": "2024-07-31T05:20:34",
"upload_time_iso_8601": "2024-07-31T05:20:34.204707Z",
"url": "https://files.pythonhosted.org/packages/1d/f7/e08b26c0bf2cf422e0f9acf1f236717af3431ede7242aeb23b4bdff5f17d/notebook_ed-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-31 05:20:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "w3cdpass",
"github_project": "notebook-ed",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "notebook-ed"
}
