No project description provided
Project description
# Boilerplate code for BrewBlox Service plugins
There is some boilerplate code involved when creating a Brewblox service plugin. This repository can be forked to avoid having to do the boring configuration.
Everything listed under **Required Changes** must be done before the package works as intended.
## How to use
* Fork this repository to your own Github account or project
* Follow all steps outlined under the various **Required Changes**
* Start coding your plugin =)
## Files
### [setup.py](./setup.py)
Used to create a distributable and installable Python package. See https://docs.python.org/3.6/distutils/setupscript.html for more information.
**Required Changes:**
* Change the `project_name` variable to your project name. This is generally the same as the repository name. This name is used when installing the package through Pip.
* Change the `package_name` variable to the module name. This can be the same name as your project name, but can't include dashes `-`. This name is used when importing your package in Python.
* Check whether all other fields are correct. Refer to the documentation for more info.
* Change the `url` parameter to the url of your repository.
* Change the `author` parameter to your name.
* Change the `author_email` parameter to your email.
### [tox.ini](./tox.ini)
This file kicks off automated testing and linting of your package. See http://tox.readthedocs.io/en/latest/config.html for more information.
**Required Changes:**
* Change `--cov=YOUR_PACKAGE` to refer to your module name.
* The `--cov-fail-under=100` makes the build fail if code coverage is less than 100%. It is optional, but recommended. Remove the `#` comment character to enable it.
### [requirements.txt](./requirements.txt)
Include all runtime requirements for your package here. See https://pip.pypa.io/en/stable/reference/pip_install/#requirements-file-format for more information.
**Note:** There is overlap between your requirements file, and the `install_requires=[]` line in `setup.py`. For most cases, the rule of thumb is that if you need an external package to run, you should add it as dependency to both files.
### [requirements-dev.txt](./requirements-dev.txt)
The file works just like [requirements.txt](./requirements.txt), but should only list the packages needed to test the code. End users do not need these dependencies.
### [MANIFEST.in](./MANIFEST.in)
This file lists all non-code files that should be part of the package.
See https://docs.python.org/3.6/distutils/sourcedist.html#specifying-the-files-to-distribute for more info.
For a basic plugin, you do not need to change anything in this file.
### [.travis.yml](./.travis.yml)
Travis CI configuration. If you haven't enabled travis for your repository: don't worry, it won't do anything.
### [.coveragerc](./.coveragerc)
This file contains some configuration for `pytest-cov`.
For a basic plugin, you do not need to change anything in this file.
### [README.md](./README.md)
Your module readme (this file). It will be the package description on Pypi.org, and automatically be displayed in Github.
**Required Changes:**
* Add all important info about your package here. What does your package do? How do you use it? What is your favorite color?
### [YOUR_PACKAGE/](./YOUR_PACKAGE/)
Your module. This directory name should match the `package_name` variable in `setup.py`.
**Required Changes:**
* Rename to the desired module name. (Python import name. Can't include dashes "-").
### [test/conftest.py](./test/conftest.py)
Project-level pytest fixtures. Some useful fixtures for testing any brewblox_service implementation are defined here. See tests in https://github.com/BrewBlox/brewblox-service/tree/develop/new/test for examples on how to use.
For a basic implementation, you do not need to change anything in this file.
### [test/test_hello.py](./test/test_hello.py)
An example on how to test aiohttp endpoints you added. Feel free to remove this once you no longer need it.
### [docker/Dockerfile](./docker/Dockerfile)
A docker file for running your package. You can use a local version of your package by copying it to `docker/pkg/` before building.
Example:
```bash
tox
mkdir -p docker/pkg
cp .tox/dist/* docker/pkg/
docker build --tag your-package docker/
docker run your-package
```
**Required Changes:**
* Rename instances of `YOUR-PACKAGE` and `YOUR_PACKAGE` in the docker file to desired module and package names.
There is some boilerplate code involved when creating a Brewblox service plugin. This repository can be forked to avoid having to do the boring configuration.
Everything listed under **Required Changes** must be done before the package works as intended.
## How to use
* Fork this repository to your own Github account or project
* Follow all steps outlined under the various **Required Changes**
* Start coding your plugin =)
## Files
### [setup.py](./setup.py)
Used to create a distributable and installable Python package. See https://docs.python.org/3.6/distutils/setupscript.html for more information.
**Required Changes:**
* Change the `project_name` variable to your project name. This is generally the same as the repository name. This name is used when installing the package through Pip.
* Change the `package_name` variable to the module name. This can be the same name as your project name, but can't include dashes `-`. This name is used when importing your package in Python.
* Check whether all other fields are correct. Refer to the documentation for more info.
* Change the `url` parameter to the url of your repository.
* Change the `author` parameter to your name.
* Change the `author_email` parameter to your email.
### [tox.ini](./tox.ini)
This file kicks off automated testing and linting of your package. See http://tox.readthedocs.io/en/latest/config.html for more information.
**Required Changes:**
* Change `--cov=YOUR_PACKAGE` to refer to your module name.
* The `--cov-fail-under=100` makes the build fail if code coverage is less than 100%. It is optional, but recommended. Remove the `#` comment character to enable it.
### [requirements.txt](./requirements.txt)
Include all runtime requirements for your package here. See https://pip.pypa.io/en/stable/reference/pip_install/#requirements-file-format for more information.
**Note:** There is overlap between your requirements file, and the `install_requires=[]` line in `setup.py`. For most cases, the rule of thumb is that if you need an external package to run, you should add it as dependency to both files.
### [requirements-dev.txt](./requirements-dev.txt)
The file works just like [requirements.txt](./requirements.txt), but should only list the packages needed to test the code. End users do not need these dependencies.
### [MANIFEST.in](./MANIFEST.in)
This file lists all non-code files that should be part of the package.
See https://docs.python.org/3.6/distutils/sourcedist.html#specifying-the-files-to-distribute for more info.
For a basic plugin, you do not need to change anything in this file.
### [.travis.yml](./.travis.yml)
Travis CI configuration. If you haven't enabled travis for your repository: don't worry, it won't do anything.
### [.coveragerc](./.coveragerc)
This file contains some configuration for `pytest-cov`.
For a basic plugin, you do not need to change anything in this file.
### [README.md](./README.md)
Your module readme (this file). It will be the package description on Pypi.org, and automatically be displayed in Github.
**Required Changes:**
* Add all important info about your package here. What does your package do? How do you use it? What is your favorite color?
### [YOUR_PACKAGE/](./YOUR_PACKAGE/)
Your module. This directory name should match the `package_name` variable in `setup.py`.
**Required Changes:**
* Rename to the desired module name. (Python import name. Can't include dashes "-").
### [test/conftest.py](./test/conftest.py)
Project-level pytest fixtures. Some useful fixtures for testing any brewblox_service implementation are defined here. See tests in https://github.com/BrewBlox/brewblox-service/tree/develop/new/test for examples on how to use.
For a basic implementation, you do not need to change anything in this file.
### [test/test_hello.py](./test/test_hello.py)
An example on how to test aiohttp endpoints you added. Feel free to remove this once you no longer need it.
### [docker/Dockerfile](./docker/Dockerfile)
A docker file for running your package. You can use a local version of your package by copying it to `docker/pkg/` before building.
Example:
```bash
tox
mkdir -p docker/pkg
cp .tox/dist/* docker/pkg/
docker build --tag your-package docker/
docker run your-package
```
**Required Changes:**
* Rename instances of `YOUR-PACKAGE` and `YOUR_PACKAGE` in the docker file to desired module and package names.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Close
Hashes for brewblox-devcon-spark-0.2.1.dev27.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 932d473ced94e8f52e0e623b2cacdfc2f2ee04e626f39d2a18b7781a4bac21e5 |
|
MD5 | a23e606b5c8b27225d41b8c53b241f81 |
|
BLAKE2b-256 | 80c058ca1e71a6936e29c2c5357d855afcb06b35f006fe6ea3ad0c7e8848631b |