11. Development¶

This section only needs to be read by developers of the smipyping package. People that want to make a fix or develop some extension, and people that want to test the project are also considered developers for the purpose of this section.

11.1. Repository¶

The repository for smipyping is on GitHub:

https://github.com/smipyping/smipyping

11.2. Setting up the development environment¶

The development environment is easy to set up.

Besides having a supported operating system with a supported Python version (see Supported environments), it is recommended that you set up a virtual Python environment.

Then, with a virtual Python environment active, clone the Git repo of this project and prepare the development environment with make develop:

$ git clone git@github.com:kschopmeyer/smipyping.git
$ cd smipyping
$ make develop

This will install all prerequisites the package needs to run, as well as all prerequisites that you need for development.

Generally, this project uses Make to do things in the currently active Python environment. The command make help (or just make) displays a list of valid Make targets and a short description of what each target does.

11.3. Building the documentation¶

The ReadTheDocs (RTD) site is used to publish the documentation for the smipyping package at http://smipyping.readthedocs.io/

This page automatically gets updated whenever the master branch of the Git repo for this package changes.

In order to build the documentation locally from the Git work directory, issue:

$ make builddoc

The top-level document to open with a web browser will be build_doc/html/docs/index.html.

11.4. Testing¶

To run unit tests in the currently active Python environment, issue one of these example variants of make test:

$ make test                                              # Run all unit tests
$ PYTHONPATH=. py.test tests/<testname>.py -s          # Run only this test source file

Invoke py.test --help for details on the expression syntax of its -k option.

To run the unit tests and some more commands that verify the project is in good shape in all supported Python environments, use Tox:

$ tox                              # Run all tests on all supported Python versions
$ tox -e py27                      # Run all tests on Python 2.7

11.5. Contributing¶

Third party contributions to this project are welcome!

In order to contribute, create a Git pull request, considering this:

Test is required.
Each commit should only contain one “logical” change.
A “logical” change should be put into one commit, and not split over multiple commits.
Large new features should be split into stages.
The commit message should not only summarize what you have done, but explain why the change is useful.
The commit message must follow the format explained below.

What comprises a “logical” change is subject to sound judgement. Sometimes, it makes sense to produce a set of commits for a feature (even if not large). For example, a first commit may introduce a (presumably) compatible API change without exploitation of that feature. With only this commit applied, it should be demonstrable that everything is still working as before. The next commit may be the exploitation of the feature in other components.

For further discussion of good and bad practices regarding commits, see:

11.6. Releasing a version of this package¶

This section shows the steps for releasing a version of smipyping.

Note that a release may be either local only or to PyPI. We will announce when we do a release to PyPI. Locally a release involves creating a branch that represents the release and tagging both that branch and the master branch with versions. I PyPI release involves then uploading the released version of the package to PyPI

Switch to your work directory of the smipyping Git repo (this is where the Makefile is), and perform the following steps in that directory:

Set a shell variable for the version to be released, e.g.:
```
MNU='0.6.0'
```
Verify that your working directory is in a Git-wise clean state:
```
git status
```
Check out the master branch, and update it from upstream:
```
git checkout master
git pull
```

Create a topic branch for the release:

git checkout -b release-$MNU
git branch --set-upstream-to origin/release-$MNU release-$MNU

Edit the change log (docs/changes.rst) and perform the following changes in the top-most section (that is the section for the version to be released):
- If needed, change the version in the section heading to the version to be released, e.g.:
```
Version 0.6.0
-------------
```
- Change the release date to today’s date, e.g.:
```
Released: 2017-03-16
```
- Make sure that the change log entries reflect all changes since the previous version, and make sure they are relevant for and understandable by users.
- In the “Known issues” list item, remove the link to the issue tracker and add any known issues you want users to know about. Just linking to the issue tracker quickly becomes incorrect for released versions:
```
**Known issues:**

* ....
```
- Remove all empty list items in the change log section for this release.

Commit your changes and push them upstream:

git add docs/changes.rst
git commit -sm "Updated change log for $MNU release."
git push

On GitHub, create a pull request for branch release-$MNU.
Perform a complete test:
```
tox
```
This should not fail because the same tests have already been run in the Travis CI. However, run it for additional safety before the release.
- If this test fails, fix any issues until the test succeeds. Commit the changes and push them upstream:
```
git add <changed-files>
git commit -sm "<change description with details>"
git push
```
  Wait for the automatic tests to show success for this change.
Once the CI tests on GitHub are complete, merge the pull request.
Update your local master branch:
```
git checkout master
git pull
```
Tag the master branch with the release label and push the tag upstream:
```
git tag $MNU
git push --tags
```
On GitHub, edit the new tag, and create a release description on it. This will cause it to appear in the Release tab.

You can see the tags in GitHub via Code -> Releases -> Tags.
Upload the package to PyPI:
```
make upload
```
This will show the package version and will ask for confirmation.

Attention!! This only works once for each version. You cannot release the same version twice to PyPI.
Verify that the released version is shown on PyPI:

https://pypi.python.org/pypi/smipyping
Verify that RTD shows the released version as its stable version:

https://smipyping.readthedocs.io/en/stable/intro.html#versioning

Note: RTD builds the documentation automatically, but it may take a few minutes to do so.
On GitHub, close milestone M.N.U.

11.7. Starting a new release¶

This section shows the steps for starting development of a new version.

These steps may be performed right after the steps for releasing to PyPI, or independently.

This description works for releases that are direct successors of the previous release. It does not cover starting a new version that is a fix release to a version that was released earlier.

Switch to your work directory of the smipyping Git repo (this is where the Makefile is), and perform the following steps in that directory:

Set a shell variable for the new version to be started:
```
MNU='0.7.0'
```
Verify that your working directory is in a git-wise clean state:
```
git status
```
Check out the master branch, and update it from upstream:
```
git checkout master
git pull
```

Create a topic branch for the release:

git checkout -b start-$MNU
git branch --set-upstream-to origin/start-$MNU start-$MNU

Edit the change log (docs/changes.rst) and insert the following section before the top-most section (which is the section about the latest released version):

Version 0.7.0
-------------

Released: not yet

**Incompatible changes:**

**Deprecations:**

**Bug fixes:**

**Enhancements:**

**Known issues:**

* See `list of open issues`_.

.. _`list of open issues`: https://github.com/kschopmeyer/smipyping/issues

Commit your changes and push them upstream:

git add docs/changes.rst
git commit -sm "Started $MNU release."
git push

On GitHub, create a pull request for branch start-$MNU.
On GitHub, create a new milestone for development of the next release, e.g. M.N.U.

You can create a milestone in GitHub via Issues -> Milestones -> New Milestone.
On GitHub, go through all open issues and pull requests that still have milestones for previous releases set, and either set them to the new milestone, or to have no milestone.
Once the CI tests on GitHub are complete, merge the pull request.
Update your local master branch:
```
git checkout master
git pull
```

11. Development¶

11.1. Repository¶

11.2. Setting up the development environment¶

11.3. Building the documentation¶

11.4. Testing¶

11.5. Contributing¶

11.6. Releasing a version of this package¶

11.7. Starting a new release¶

Table of Contents

Previous topic

Next topic

This Page