rsrc
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
- with
PyPy
pypy -m pip install --upgrade rsrc
Developer
Download the latest version from GitHub
repository
git clone https://github.com/lycantropos/rsrc.git
cd rsrc
Install dependencies:
- with
CPython
python -m pip install --force-reinstall -r requirements.txt
- with
PyPy
pypy -m pip install --force-reinstall -r requirements.txt
Install:
- with
CPython
python setup.py install
- with
PyPy
pypy setup.py install
Usage
The main idea is to use setuptools
feature
called "Dynamic Discovery of Services and Plugins".
Assuming we have a package rsrc_ftp
with structure
|_ rsrc_ftp.py
|_ setup.py
which adds support for URLs with ftp
scheme
rsrc_ftp.py
from rsrc.models import Resource
def deserialize(string: str) -> Resource:
...
to make it available for rsrc
package
we should register its entry point
(rsrc_ftp::deserialize
function in our case)
setup.py
from setuptools import setup
from rsrc import plugins
plugins_entry_points = [
plugins.to_entry_point(id_=plugins.to_id('ftp'),
module_name='rsrc_ftp',
function_name='deserialize'),
]
setup(name='rsrc_ftp',
py_modules=['rsrc_ftp'],
entry_points={plugins.__name__: plugins_entry_points},
install_requires=['rsrc'])
After that the installation of rsrc_ftp
package
will register rsrc_ftp::deserialize
function in rsrc
package
as an entry point for resources with ftp
scheme
>>> from rsrc.base import deserialize
>>> ftp_resource = deserialize('ftp://path/to/resource')
>>> ftp_resource.url
URL('ftp', 'path', '/to/resource', '', '', '')
Plugins
-
rsrc_local
-- adds support for local/local network resources. -
rsrc_web
-- adds support for web resources (bothhttp
&https
schemes).
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 --force-reinstall -r requirements-tests.txt
- with
PyPy
pypy -m pip install --force-reinstall -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