Skip to content

Latest commit

 

History

History
99 lines (65 loc) · 2.49 KB

CONTRIBUTING.md

File metadata and controls

99 lines (65 loc) · 2.49 KB

Contributing

Setup development environment

Download

Make a fork of the main jupyter-docx-bundler repository and clone the fork

git clone https://github.com/<your-github-username>/jupyter-docx-bundler

Contributions to jupyter-docx-bundler can then be made by submitting pull requests on GitHub.

Install

To build the library you can install the necessary requirements using pip or conda

cd jupyter-docx-bundler

conda

Install all development requirements by executing

conda install --file requirements.txt --file requirements_test.txt pandoc

Install the package in editable mode by executing

pip install --no-deps -e .

Make the package available to nbconvert and as an entry in the Download As menu by executing

jupyter bundlerextension enable --py jupyter_docx_bundler --sys-prefix

pip

Make sure you have Pandoc installed, see installing-pandoc for instructions.

Install the package in editable mode and all necessary requirements by executing

pip install -e ".[test]"

Make the package available to nbconvert and as an entry in the Download As menu by executing

jupyter bundlerextension enable --py jupyter_docx_bundler --sys-prefix

Test

Test the package with pytest by executing the following command

pytest .

Build

PyPI.org

This package follows the packaing guide and you can create new packages for PyPI by executing.

python setup.py sdist bdist_wheel

Anaconda.org

Furthermore this package is also build with conda-build by executing the following command for Python 3.9

conda-build conda.recipe python=3.9

As documented in noarch-builds a Python- and OS-dependent build is necessary.

Release

  1. git tag a commit with a new version like 0.3.1
  2. Let the GitHub Actions pass, it builds all PyPI and conda-packages. You can download them as artifacts.
  3. Put the PyPI-artifacts in the folder dist. Upload the packages to PyPI with 
    twine upload dist/*
  4. Upload the conda-packages to anaconda.org with 
    anaconda upload jupyter-docx-bundler-0.3.1-py39_0.tar.bz2