Publish Peek Plugins¶
The peek package has build scripts that generate a platform build.
Important
Windows users must use bash.
Create Private Plugin Release¶
Note
Do not follow this step if you intend on using a public release, see Create PyPI Public Release
Change root directory of peek-plugin, example:
cd peek-plugin-example/
Ensure RELEASE_DIR is where you want the release:
echo $RELEASE_DIR
Ensure that the file publish.sh
variable PYPI_PUBLISH
is blank
# Leave blank not to publish
# Or select one of the index servers defined in ~/.pypirc
PYPI_PUBLISH=""
Run the follow command being sure to increment the version number:
./publish.sh #.#.#
Expected response like:
$ ./publish.sh 0.0.7
Setting version to 0.0.7
...
Not publishing to any pypi indexes
Create PyPI Public Release¶
The Python Package Index is a repository of software for the Python programming language.
Create file ~/.pypirc
¶
Create file ~/.pypirc
and populate with the following:
[distutils]
index-servers=
pypi
[pypi]
repository = https://pypi.python.org/pypi
username = <your user name goes here>
password = <your password goes here>
Note
Make sure you update the username
and password
.
Run script publish.sh
¶
Change root directory of peek-plugin, example:
cd peek-plugin-example/
Ensure RELEASE_DIR is where you want the release:
echo $RELEASE_DIR
Ensure that the file publish.sh
variable PYPI_PUBLISH
is set to the
index of the PyPI server defined in ~/.pypirc
:
# Leave blank not to publish
# Or select one of the index servers defined in ~/.pypirc
PYPI_PUBLISH="pypi"
Run the follow command, being sure to increment the version number:
./publish.sh #.#.#
Expected response like:
$ ./publish.sh 0.0.7
Setting version to 0.0.7
...
Writing peek-plugin-tutorial-0.0.7\setup.cfg
Creating tar archive
removing 'peek-plugin-tutorial-0.0.7' (and everything under it)
running upload
Submitting dist\peek-plugin-tutorial-0.0.7.tar.gz to https://upload.pypi.org/legacy/
Server response (200): OK
Check uploaded release on PyPI.
What Next?¶
Refer back to the How to Use Peek Documentation guide to see which document to follow next.