Skip to main content

Python project template.

Project description


In what follows

  • python is an alias for python3.5 or any later version (python3.6 and so on),
  • pypy is an alias for pypy3.5 or any later version (pypy3.6 and so on).


Install the latest pip & setuptools packages versions:

  • with CPython
    python -m pip install --upgrade pip setuptools
  • with PyPy
    pypy -m pip install --upgrade pip setuptools


Download and install the latest stable version from PyPI repository:

  • with CPython
    python -m pip install --upgrade memoir
  • with PyPy
    pypy -m pip install --upgrade memoir


Download the latest version from GitHub repository

git clone
cd memoir


  • with CPython
    python install
  • with PyPy
    pypy install


Let's suppose we are defining a class with expensive read-only property which can be calculated once and reused afterwards.

Common way of solving this is by introducing "private" attribute like

class Example:
    def expensive_property(self):
            result = self._expensive_property
        except AttributeError:
            result = do_expensive_calculations(...)
            self._expensive_property = result
        return result

this works fine, but

  • mutates original instance by introducing a new attribute,
  • requires a lot of boilerplate each time.

If we have

class we can implement it like

from memoir import cached

class Example:
    def expensive_property(self):
        return do_expensive_calculations(...)


Bumping version


Install bump2version.


Choose which version number category to bump following semver specification.

Test bumping version

bump2version --dry-run --verbose $CATEGORY

where $CATEGORY is the target version number category name, possible values are patch/minor/major.

Bump version

bump2version --verbose $CATEGORY

This will set version to major.minor.patch-alpha.


Test bumping version

bump2version --dry-run --verbose --tag release

Bump version

bump2version --verbose --tag release

This will set version to major.minor.patch and add Git tag.


To avoid inconsistency between branches and pull requests, bumping version should be merged into master branch as separate pull request.

Running tests


  • with CPython
    python test
  • with PyPy
    pypy test

Inside Docker container:

  • with CPython
    docker-compose --file docker-compose.cpython.yml up
  • with PyPy
    docker-compose --file docker-compose.pypy.yml up

Bash script (e.g. can be used in Git hooks):

  • with CPython



    ./ cpython
  • with PyPy

    ./ pypy

PowerShell script (e.g. can be used in Git hooks):

  • with CPython
    .\run-tests.ps1 cpython
  • with PyPy
    .\run-tests.ps1 pypy

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

memoir-0.0.1.tar.gz (3.9 kB view hashes)

Uploaded Source

Built Distribution

memoir-0.0.1-py3-none-any.whl (4.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page