Skip to content

Commit

Permalink
Readme touch-ups.
Browse files Browse the repository at this point in the history
  • Loading branch information
TomerFi committed Oct 25, 2019
1 parent e9e44a3 commit d5ff14a
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 108 deletions.
32 changes: 0 additions & 32 deletions .snyk

This file was deleted.

1 change: 0 additions & 1 deletion .spelling
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,6 @@ semvar
sexualized
shellcheck
shellscripts
snyk
sphinx-rtd-theme
stdout
sublicense
Expand Down
29 changes: 2 additions & 27 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Contributing is pretty straight-forward:
- Fork the repository
- Commit your changes
- Create a pull request against the `dev` branch

Please feel free to contribute, even to this contributing guideline file, if you see fit.

**Content**
Expand All @@ -33,7 +33,6 @@ Please feel free to contribute, even to this contributing guideline file, if you
- [Codacy](#codacy)
- [Requires-io](#requires-io)
- [David-DM](#david-dm)
- [Snyk](#snyk)

- [Continuous Deployment](#continuous-deployment)
- [Docker Hub](#docker-hub)
Expand All @@ -49,10 +48,6 @@ Please feel free to contribute, even to this contributing guideline file, if you
- [Shell Scripts](#shell-scripts)
- [Makefile](#makefile)

- [Chat](#chat)

- [Best Practices](#best-practices)

- [Code of Conduct](#code-of-conduct)

## Items description
Expand Down Expand Up @@ -179,12 +174,6 @@ is keeping an eye for versions updates upon the python requirements listed in th
[David-DM](https://david-dm.org/TomerFi/switcher_webapi) is keeping an eye for versions updates upon
the npm requirements listed in the *package.json* file.

### Snyk
[Snyk](https://snyk.io) is keeping an eye out for vulnerabilities in our
[npm dependencies](https://snyk.io/test/github/TomerFi/switcher_webapi?targetFile=package.json),
our [pypi requirements](https://snyk.io/test/github/TomerFi/switcher_webapi?targetFile=requirements.txt)
and our *docker image dependencies*.

## Continuous Deployment
### Docker Hub
When a **git-tag** with the regex of `/^[0-9.]+$/` is set, [Docker Hub Cloud](https://hub.docker.com/r/tomerfi/switcher_webapi/builds)
Expand Down Expand Up @@ -334,7 +323,7 @@ For automated local tests, use `tox`.
Here are some guidelines (recommendations) for contributing to the `switcher_webapi` project:
- Code docstrings documentation [here](codedocs.html)

- If you add a python dependency, for order keeping and for [Snyk](https://snyk.io)'s sake,
- If you add a python dependency, for legacy support,
Please add the dependency with the fixed version to [requirements.txt](requirements.txt),
And add with no version statement in any or all of the other requirements file based on the
dependency use case.
Expand Down Expand Up @@ -441,20 +430,6 @@ especially in regards to docker operations, try `make help` to list all the avai
- `make verify-environment-file` will verify the existence of the required
environment variables file and its content.

## Chat
Feel free to join the project's public
[Slack Channel](https://tomfi.slack.com/messages/CK4DK2Z5G)</br>
GitHub, Codacy Docker Hub and Snyk are integrated with the channel and keep its members updated.

## Best Practices
This project tries to follow the [CII Best Practices](https://bestpractices.coreinfrastructure.org/en/projects/2891) guidelines.

That's not an easy task and I'm not sure achieving 100% is even possible for this specific
project.</br>
At the time writing this, the project has achieved 42% (The writing of this file was actually
according one to those guidelines).</br>
Any contribution bumping up this percentage will be gladly embraced.

## Code of Conduct
The [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) can also be found
[here](https://switcher-webapi.readthedocs.io/en/stable/conduct.html).
26 changes: 6 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
<!--lint disable maximum-heading-length-->
![tomfi-repo-logo](https://media.githubusercontent.com/media/TomerFi/portfolio/gh-pages/images/TomFiRepoWhite.png)
# Switcher Water Heater Unofficial Docker-based WebAPI [![shields-io-maintenance]][12] [![microbadger-docker-version]][9] [![microbadger-docker-license]][11] [![shields-io-docker-pulls]][10] [![self-hosted-slack-channel]][14] [![cii-best-practices]][13]
# Switcher Water Heater Unofficial Docker-based WebAPI</br>[![shields-io-maintenance]][12] [![microbadger-docker-version]][9] [![microbadger-docker-license]][11] [![shields-io-docker-pulls]][10]

| Stage | Badges |
| --------- | --------------------------------------------------------------------------------------------------------- |
| `Code` | [![codecov]][0] [![codacy]][1] [![code-style-black]][15] [![checked-with-mypy]][16] |
| `Builds` | [![circleci]][2] [![shields-io-docker-cloud-build-status]][3] [![read-the-docs]][4] [![license-scan]][18] |
| `Pypi` | [![requires-io]][5] [![snyk-python]][6] |
| `Npm` | [![david-dm-dev-package-json-dependencies-status]][7] [![snyk-npm]][8] [![greenkeeper-badge]][17] |
| Stage | Badges |
| --------- | ------------------------------------------------------------------------------------------------------------------ |
| `Build` | [![circleci]][2] [![shields-io-docker-cloud-build-status]][3] [![codecov]][0] [![codacy]][1] [![read-the-docs]][4] |
| `Package` | [![requires-io]][5] [![david-dm-dev-package-json-dependencies-status]][7] |
| `Etc` | [![greenkeeper-badge]][17] [![code-style-black]][15] [![checked-with-mypy]][16] |

An asynchronous [sanic webapp](https://pypi.org/project/sanic/) running inside a [python docker image](https://hub.docker.com/_/python) using [uvloop](https://pypi.org/project/uvloop/) as the event loop.</br>
Used as a rest api wrapper for [aioswitcher](https://pypi.org/project/aioswitcher/).</br>
Expand All @@ -18,45 +16,33 @@ For full install and usage instructions,
Please check out the [Switcher water heater WebAPI documentation](https://switcher-webapi.readthedocs.io)
hosted with [readthedocs.io](https://readthedocs.org/).

[![Say Thanks!](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/TomerFi)

<!-- Real Links -->
[0]: https://codecov.io/gh/TomerFi/switcher_webapi
[1]: https://www.codacy.com/app/TomerFi/switcher_webapi?utm_source=github.com&utm_medium=referral&utm_content=TomerFi/switcher_webapi&utm_campaign=Badge_Grade
[2]: https://circleci.com/gh/TomerFi/switcher_webapi
[3]: https://hub.docker.com/r/tomerfi/switcher_webapi/builds
[4]: https://switcher-webapi.readthedocs.io/en/stable/?badge=stable
[5]: https://requires.io/github/TomerFi/switcher_webapi/requirements
[6]: https://snyk.io//test/github/TomerFi/switcher_webapi?targetFile=requirements.txt
[7]: https://david-dm.org/TomerFi/switcher_webapi
[8]: https://snyk.io//test/github/TomerFi/switcher_webapi?targetFile=package.json
[9]: https://microbadger.com/images/tomerfi/switcher_webapi
[10]: https://hub.docker.com/r/tomerfi/switcher_webapi
[11]: https://github.com/TomerFi/switcher_webapi/blob/dev/LICENSE
[12]: https://github.com/TomerFi/switcher_webapi
[13]: https://bestpractices.coreinfrastructure.org/projects/2891
[14]: https://tomfi.slack.com/messages/CK4DK2Z5G
[15]: https://black.readthedocs.io/en/stable/
[16]: http://mypy-lang.org/
[17]: https://greenkeeper.io/
[18]: https://app.fossa.io/projects/git%2Bgithub.com%2FTomerFi%2Fswitcher_webapi
<!-- Badges Links -->
[checked-with-mypy]: http://www.mypy-lang.org/static/mypy_badge.svg
[cii-best-practices]: https://bestpractices.coreinfrastructure.org/projects/2891/badge
[circleci]: https://circleci.com/gh/TomerFi/switcher_webapi.svg?style=shield
[codacy]: https://api.codacy.com/project/badge/Grade/bc33021329894d75943f8d0fe77b95a5
[codecov]: https://codecov.io/gh/TomerFi/switcher_webapi/graph/badge.svg
[code-style-black]: https://img.shields.io/badge/code%20style-black-000000.svg
[david-dm-dev-package-json-dependencies-status]: https://david-dm.org/TomerFi/switcher_webapi/status.svg
[greenkeeper-badge]: https://badges.greenkeeper.io/TomerFi/switcher_webapi.svg
[license-scan]: https://app.fossa.io/api/projects/git%2Bgithub.com%2FTomerFi%2Fswitcher_webapi.svg?type=shield
[microbadger-docker-license]: https://images.microbadger.com/badges/license/tomerfi/switcher_webapi.svg
[microbadger-docker-version]: https://images.microbadger.com/badges/version/tomerfi/switcher_webapi.svg
[read-the-docs]: https://readthedocs.org/projects/switcher-webapi/badge/?version=stable
[requires-io]: https://requires.io/github/TomerFi/switcher_webapi/requirements.svg
[self-hosted-slack-channel]: https://slack.tomfi.info:8443/switcher_webapi.svg
[shields-io-docker-cloud-build-status]: https://img.shields.io/docker/cloud/build/tomerfi/switcher_webapi.svg
[shields-io-docker-pulls]: https://img.shields.io/docker/pulls/tomerfi/switcher_webapi.svg
[shields-io-maintenance]: https://img.shields.io/badge/Maintained%3F-yes-green.svg
[snyk-npm]: https://snyk.io//test/github/TomerFi/switcher_webapi/badge.svg?targetFile=package.json
[snyk-python]: https://snyk.io//test/github/TomerFi/switcher_webapi/badge.svg?targetFile=requirements.txt
29 changes: 1 addition & 28 deletions docs/source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -161,12 +161,6 @@ David-DM
`David-DM`_ is keeping an eye for versions updates upon the npm requirements listed in the
*package.json* file.

Snyk
----

Snyk_ is keeping an eye out for vulnerabilities in our `npm dependencies`_,
our `pypi requirements`_ and our *docker image dependencies*.

Continuous Deployment
^^^^^^^^^^^^^^^^^^^^^

Expand Down Expand Up @@ -328,7 +322,7 @@ Guidelines
Here are some guidelines (recommendations) for contributing to the ``switcher_webapi`` project:
* `Code docstrings documentation is here`_.

* If you add a python dependency, for order keeping and for Snyk_'s sake,
* If you add a python dependency, for legacy support,
Please add the dependency with the fixed version to ``requirements.txt``,
And add with no version statement in any or all of the other requirements file based on the
dependency use case.
Expand Down Expand Up @@ -440,22 +434,6 @@ Try ``make help`` to list all the available tasks:
* ``make verify-environment-file`` will verify the existence of the required environment
variables file and its content.

Chat
^^^^

Feel free to join the project's public `Slack Channel`_.
GitHub, Codacy Docker Hub and Snyk are integrated with the channel and keeping its members updated.

Best Practices
^^^^^^^^^^^^^^

This project tries to follow the `CII Best Practices`_ guidelines.
That's not an easy task and I'm not sure achieving 100% is even possible for this specific project.
At the time writing this, the project has achieved 42%.
(The writing of this file was actually according one to those guidelines).

Any contribution bumping up this percentage will be gladly embraced.

.. _aioswitcher pypi module: https://pypi.org/project/aioswitcher/
.. _module repository here: https://github.com/TomerFi/aioswitcher
.. _CircleCi Continuous Integration and Deployment Services: https://circleci.com/gh/TomerFi/switcher_webapi/tree/dev
Expand Down Expand Up @@ -513,14 +491,9 @@ Any contribution bumping up this percentage will be gladly embraced.
.. _run remark: https://remark.js.org/
.. _run prettier: https://prettier.io/
.. _Docker: https://www.docker.com/
.. _Slack Channel: https://tomfi.slack.com/messages/CK4DK2Z5G
.. _CII Best Practices: https://bestpractices.coreinfrastructure.org/en/projects/2891
.. _black: https://pypi.org/project/black/
.. _PEP518: https://www.python.org/dev/peps/pep-0518/
.. _markdown-spellcheck: https://www.npmjs.com/package/markdown-spellcheck
.. _snyk: https://snyk.io
.. _npm dependencies: https://snyk.io/test/github/TomerFi/switcher_webapi?targetFile=package.json
.. _pypi requirements: https://snyk.io/test/github/TomerFi/switcher_webapi?targetFile=requirements.txt
.. _vale: https://errata-ai.github.io/vale/
.. _vale styles: https://errata-ai.github.io/vale/styles/
.. _vale repository: https://github.com/errata-ai/vale/tree/master/docs/styles
Expand Down

0 comments on commit d5ff14a

Please sign in to comment.