Skip to main content

Watch me coding, a toolbox

Project description

PyPI Python Version Wheel Implementation Downloads License

Create some screen recording. I would like to share my coding process. This small tool should help me. But you can use it for any long time recording.

It’s still under develop, but you can try it. See “How does it work” for more information

Install

It is on PyPi:

pip install wmc

or:

pip install wmc[full]

to get all features.

Hot to uses

Create a new project. This is basically a folder with a settings file:

wmc setup .
wmc setup test

You can edit the config file or simple start recording:

wmc record

Use the help for more:

>>> wmc --help
usage: wmc [-h] [-V] [-v] [-s SETTINGS] [-H] [{info,link,record,setup}] [path]

Watch me coding, a toolbox

positional arguments:
  {info,link,record,setup}
                        Select one command.
  path                  Path to the project.


optional arguments:
  -h, --help            show this help message and exit
  -V, --version         show program's version number and exit
  -v, --verbose         Enable debug infos.
  -s SETTINGS, --settings SETTINGS
                        The settings file.
  -H, --help-commands   Some command infos.

Copyright 2019 AxJu | WMCv0.1.1

How does it work

The workplace is simple folder with a data file. Every command work with this folder and the settings from the data file. To manage the different commands I create a basic class and uses the entry_points from the setuptools. This make it also easy to write custom commands. Write your own package, integrate your command to the entry_points and the command is variable. To create the command you can inherit from the basic class and then override the functions.

Development

Virtual environment windows:

python -m venv venv
venv\Scripts\activate

Virtual environment linux:

python3 -m venv venv
source venv/bin/activate

Setup project:

python -m pip install --upgrade pip wheel setuptools tox flake8 pylama pylint coverage
python setup.py develop

Run some test:

tox
python setup.py test
python setup.py flake8
python setup.py check

Test coverage:

coverage run --source wmc setup.py test
coverage report -m

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

wmc-0.3.0.tar.gz (8.0 kB view hashes)

Uploaded Source

Built Distribution

wmc-0.3.0-py3-none-any.whl (11.1 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