rsrc_local
In what follows
-
python
is an alias forpython3.5
or any later version (python3.6
and so on), -
pypy
is an alias forpypy3.5
or any later version (pypy3.6
and so on).
Installation
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
User
Download and install the latest stable version from PyPI
repository:
- with
CPython
python -m pip install --upgrade rsrc_local
- with
PyPy
pypy -m pip install --upgrade rsrc_local
Developer
Download the latest version from GitHub
repository
git clone https://github.com/lycantropos/rsrc_local.git
cd rsrc_local
Install dependencies:
- with
CPython
python -m pip install -r requirements.txt
- with
PyPy
pypy -m pip install -r requirements.txt
Install:
- with
CPython
python setup.py install
- with
PyPy
pypy setup.py install
Usage
>>> from rsrc.base import deserialize
>>> import os
>>> directory = deserialize(os.getcwd())
>>> directory.exists()
True
>>> next(iter(directory), None) is not None # directory is not empty
True
>>> from rsrc_local.models import File
>>> is_local_file = File.__instancecheck__
>>> file = next(filter(is_local_file, directory))
>>> file.exists()
True
Development
Bumping version
Preparation
Install bump2version.
Pre-release
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
.
Release
Test bumping version
bump2version --dry-run --verbose release
Bump version
bump2version --verbose release
This will set version to major.minor.patch
.
Notes
To avoid inconsistency between branches and pull requests,
bumping version should be merged into master
branch
as separate pull request.
Running tests
Install dependencies:
- with
CPython
python -m pip install -r requirements-tests.txt
- with
PyPy
pypy -m pip install -r requirements-tests.txt
Plain
pytest
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
./run-tests.sh
or
./run-tests.sh cpython
-
with
PyPy
./run-tests.sh pypy
PowerShell
script (e.g. can be used in Git
hooks):
- with
CPython
or.\run-tests.ps1
.\run-tests.ps1 cpython
- with
PyPy
.\run-tests.ps1 pypy