First, fork the project.
# Clone your fork into your local machine.
# This will create the `origin` remote pointing to your fork.
git clone [email protected]:<your-username>/md2ipynb.git
cd md2ipynb
# Add an `upstream` remote pointing to the original repository.
git remote add upstream [email protected]:davidcavazos/md2ipynb.git
Make sure you have virtualenv
installed.
pip install -U virtualenv
Create and activate a new virtualenv
.
python -m virtualenv env
source env/bin/activate
Note: Once you are all done, you can deactivate it by running
deactivate
.
Install the package in "editable" (development) mode.
pip install -e .
First, make sure you're on the latest version.
git checkout master
git pull --rebase upstream master
git push
Now, create a new branch for your changes. Try to use a short and descriptive name for your changes.
# Create a new branch and change to it.
git checkout -b your-branch
You can now modify whatever you want.
Make sure you add tests for any new functionality or fix you do.
If it's in a new file, append the *_test.py
prefix to the file.
# To run all the tests.
python setup.py test
# To run a specific test file.
# python setup.py test -s <package>.<test_file>
python setup.py test -s md2ipynb.read.paragraphs_test
# To run a specific test suite.
# python setup.py test -s <package>.<test_file>.<TestSuite>
python setup.py test -s md2ipynb.read.paragraphs_test.ParagraphsTest
# To run a specific test.
# python setup.py test -s <package>.<test_file>.<TestSuite>.<test_name>
python setup.py test -s md2ipynb.read.paragraphs_test.ParagraphsTest.test_paragraphs
After all the tests pass, you'll have to create a "Pull Request" with your changes. You can create a single commit with all the changes.
Note: You can check your changes with
git status
.
# Create a commit and push it to your fork's branch.
git add .
git commit -m 'One line description of your changes'
git push origin your-branch
Then you can follow the link in your terminal, or navigate to md2ipynb, to create a "Pull Request".
If you need to add further modifications, you'll have to:
git add . git commit -m 'One line description of further changes' git push origin your-branchAfterwards, it will reflect automatically on the Pull Request.
Once everything is okay, it can be merged.
Make sure you have some more tools installed.
pip install -U twine
Change the version on setup.py
.
Then, generate the distribution archives.
# Make sure there are no previous builds.
rm -rf dist/
# Build the distribution package.
python setup.py sdist bdist_wheel
# Check any problems with the README.
twine check dist/*
Note: It is highly recommended to publish to
TestPyPI
before publishing toPyPI
.# To upload to TestPyI. twine upload --repository-url https://test.pypi.org/legacy/ dist/* # To install from TestPyPI. pip install --index-url https://test.pypi.org/simple/ --no-deps md2ipynbIf everything is working correctly, go ahead and publish to
PyPI
.
To upload to PyPI
.
twine upload dist/*