Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/w3cdpass/notebook-ed
file extension convertor from .py to .ipynb
https://github.com/w3cdpass/notebook-ed
cli-tool converter-py-to-ipynb convertor notebook-ed pytoipynb
Last synced: about 1 month ago
JSON representation
file extension convertor from .py to .ipynb
- Host: GitHub
- URL: https://github.com/w3cdpass/notebook-ed
- Owner: w3cdpass
- License: other
- Created: 2024-07-27T05:00:50.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-08-08T07:28:22.000Z (3 months ago)
- Last Synced: 2024-09-29T00:01:46.357Z (about 2 months ago)
- Topics: cli-tool, converter-py-to-ipynb, convertor, notebook-ed, pytoipynb
- Language: Python
- Homepage:
- Size: 800 KB
- Stars: 4
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# 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/)
[](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 # To convert all .py files in a directory
notebook-ed -f # 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//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 [[email protected]](mailto:[email protected]).