summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--CHANGELOG.md9
-rw-r--r--CHANGELOG.rst13
-rw-r--r--CODE_OF_CONDUCT.rst (renamed from CODE_OF_CONDUCT.md)38
-rw-r--r--CONTRIBUTING.rst2
-rw-r--r--LICENSE.rst (renamed from LICENSE)1
-rw-r--r--README.md69
-rw-r--r--README.rst81
-rw-r--r--poetry.lock22
-rw-r--r--pyproject.toml2
9 files changed, 134 insertions, 103 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
deleted file mode 100644
index 0e29493..0000000
--- a/CHANGELOG.md
+++ /dev/null
@@ -1,9 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a
-Changelog](https://keepachangelog.com/en/1.0.0/), and this project
-adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## Unreleased
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
new file mode 100644
index 0000000..63b936f
--- /dev/null
+++ b/CHANGELOG.rst
@@ -0,0 +1,13 @@
+Changelog
+=========
+
+All notable changes to this project will be documented in this file.
+
+The format is based on `Keep a
+Changelog <https://keepachangelog.com/en/1.0.0/>`_, and this project
+adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_.
+
+Unreleased
+----------
+
+ - Initial Release \ No newline at end of file
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.rst
index 82358df..4f97603 100644
--- a/CODE_OF_CONDUCT.md
+++ b/CODE_OF_CONDUCT.rst
@@ -1,6 +1,8 @@
-# Contributor Covenant Code of Conduct
+Contributor Covenant Code of Conduct
+====================================
-## Our Pledge
+Our Pledge
+----------
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
@@ -9,29 +11,36 @@ size, disability, ethnicity, sex characteristics, gender identity and expression
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.
-## Our Standards
+Our Standards
+-------------
Examples of behavior that contributes to creating a positive environment
include:
* Using welcoming and inclusive language
+
* Being respectful of differing viewpoints and experiences
+
* Gracefully accepting constructive criticism
+
* Focusing on what is best for the community
+
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
-* The use of sexualized language or imagery and unwelcome sexual attention or
- advances
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+
* Trolling, insulting/derogatory comments, and personal or political attacks
+
* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
- address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
- professional setting
-## Our Responsibilities
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+Our Responsibilities
+--------------------
Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
@@ -43,7 +52,8 @@ that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
-## Scope
+Scope
+-----
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
@@ -52,7 +62,8 @@ address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.
-## Enforcement
+Enforcement
+-----------
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at eugenetriguba@gmail.com. All
@@ -65,7 +76,8 @@ Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.
-## Attribution
+Attribution
+-----------
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
new file mode 100644
index 0000000..83dd8e9
--- /dev/null
+++ b/CONTRIBUTING.rst
@@ -0,0 +1,2 @@
+Contributing Guidelines
+======================= \ No newline at end of file
diff --git a/LICENSE b/LICENSE.rst
index dc40d56..e42b07f 100644
--- a/LICENSE
+++ b/LICENSE.rst
@@ -1,4 +1,5 @@
MIT License
+===========
Copyright (c) 2020 Eugene Triguba
diff --git a/README.md b/README.md
deleted file mode 100644
index 444ef4e..0000000
--- a/README.md
+++ /dev/null
@@ -1,69 +0,0 @@
-# LIRC
-
-> Interact with the LIRC daemon
-
-![Python](https://img.shields.io/badge/python-3.6%20%7C%203.7%20%7C%203.8-blue)
-[![Version](https://img.shields.io/pypi/v/lirc)](https://pypi.org/project/lirc/)
-[![Black](https://img.shields.io/badge/style-black-black)](https://pypi.org/project/black/)
-[![Documentation Status](https://readthedocs.org/projects/lirc/badge/?version=latest)](https://lirc.readthedocs.io/en/latest/?badge=latest)
-[![Build Status](https://github.com/eugenetriguba/lirc/workflows/python%20package%20ci/badge.svg?branch=master)](https://github.com/eugenetriguba/lirc/actions/)
-[![Codecov](https://codecov.io/gh/eugenetriguba/lirc/graph/badge.svg)](https://codecov.io/gh/eugenetriguba/lirc)
-
-LIRC is a python package that allows you to interact with
-the daemon in the Linux Infrared Remote Control package.
-
-More information on the lircd daemon, socket interface,
-reply packet format, etc. can be found at https://www.lirc.org/html/lircd.html
-
-## Installation
-
-The package is hosted on PyPI and can be installed
-through pip.
-
-```
-$ pip install lirc
-```
-
-However since this is a wrapper around the LIRC daemon, it
-is expected that LIRC is installed and setup on the given
-system.
-
-## Usage
-
-```python
-from lirc import Lirc
-
-lirc = Lirc()
-response = lirc.version()
-
-print(response.command)
->>> 'VERSION'
-print(response.success)
->>> True
-print(response.data)
->>> ['0.10.1']
-```
-
-To get started with the package, we import `Lirc` and can
-initialize it with the defaults by passing it no arguments.
-
-This will assume a socket path of `/var/run/lirc/lircd`.
-Furthermore, this will also then assume a socket connection
-using AF_UNIX and SOCK_STREAM. These are both the defaults
-that should work on a Linux system. There are ports of LIRC
-to Windows and macOS but using the package there is far less
-common. However, both of these are configurable through options
-passed to `Lirc` to allow it to be used on those operating systems
-as well.
-
-After sending any command to the LIRC daemon, this package will create
-a `LircResponse` for us that it returns. That response contains the
-command we sent to LIRC, whether it was successful, and any data that
-was returned back to us.
-
-Further documentation and a full API specification is available at
-https://lirc.readthedocs.org
-
-## License
-
-The [MIT](./LICENSE) License \ No newline at end of file
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..27a629b
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,81 @@
+LIRC Python Package
+===================
+
+.. image:: https://img.shields.io/badge/python-3.6%20%7C%203.7%20%7C%203.8-blue
+ :alt: Python Version
+.. image:: https://img.shields.io/pypi/v/lirc
+ :target: https://pypi.org/project/lirc/
+ :alt: Project Version
+.. image:: https://readthedocs.org/projects/lirc/badge/?version=latest
+ :target: https://lirc.readthedocs.io/en/latest/?badge=latest
+ :alt: Documentation Status
+.. image:: https://github.com/eugenetriguba/lirc/workflows/python%20package%20ci/badge.svg?branch=master
+ :target: https://github.com/eugenetriguba/lirc/actions/
+ :alt: Build Status
+.. image:: https://codecov.io/gh/eugenetriguba/lirc/graph/badge.svg
+ :target: https://codecov.io/gh/eugenetriguba/lirc
+ :alt: Code Coverage
+.. image:: https://img.shields.io/pypi/l/lirc.svg
+ :target: https://pypi.python.org/pypi/lirc/
+ :alt: License
+
+This is a python package that allows you to interact with the daemon in the
+`Linux Infrared Remote Control <https://lirc.org>`_ package. Interacting with
+the daemon allows you to be able to send IR signals from computer.
+
+More information on the lircd daemon, socket interface,
+reply packet format, etc. can be found at https://www.lirc.org/html/lircd.html
+
+Installation
+------------
+
+This package is hosted on PyPI and can be installed
+through pip.
+
+.. code-block:: bash
+
+ $ pip install lirc
+
+However since this is a wrapper around the LIRC daemon, it
+is expected that LIRC is installed and setup on the given
+system as well.
+
+More information on that can be found in the `installation <./installation.html>`_ portion
+of the documentation.
+
+Using the Lirc Package
+----------------------
+
+.. code-block:: python
+
+ from lirc import Lirc
+
+ lirc = Lirc()
+ response = lirc.version()
+
+ print(response.command)
+ >>> 'VERSION'
+ print(response.success)
+ >>> True
+ print(response.data)
+ >>> ['0.10.1']
+
+To get started with the package, we import ``Lirc`` and can
+initialize it with the defaults by passing it no arguments.
+
+This will assume a socket path of ``/var/run/lirc/lircd``.
+Furthermore, this will also then assume a socket connection
+using ``AF_UNIX`` and ``SOCK_STREAM``. These are both the defaults
+that should work on a Linux system. There are ports of LIRC
+to Windows and macOS but using the package there is far less
+common. However, both of these are configurable through options
+passed to ``Lirc`` to allow it to be used on those operating systems
+as well.
+
+After sending any command to the LIRC daemon, this package will create
+a ``LircResponse`` for us that it returns. That response contains the
+command we sent to LIRC, whether it was successful, and any data that
+was returned back to us.
+
+Further documentation and a full API specification is available at
+https://lirc.readthedocs.org
diff --git a/poetry.lock b/poetry.lock
index ba463f7..fe3fc7b 100644
--- a/poetry.lock
+++ b/poetry.lock
@@ -212,7 +212,7 @@ marker = "python_version >= \"3.6.1\" and python_version < \"4.0.0\""
name = "identify"
optional = false
python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,>=2.7"
-version = "1.4.21"
+version = "1.4.23"
[package.extras]
license = ["editdistance"]
@@ -272,7 +272,7 @@ description = "A Python utility / library to sort Python imports."
name = "isort"
optional = false
python-versions = ">=3.6,<4.0"
-version = "5.0.4"
+version = "5.0.9"
[package.extras]
pipfile_deprecated_finder = ["pipreqs", "requirementslib", "tomlkit (>=0.5.3)"]
@@ -723,11 +723,11 @@ marker = "python_version >= \"3.6.1\" and python_version < \"4.0.0\""
name = "virtualenv"
optional = false
python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,>=2.7"
-version = "20.0.25"
+version = "20.0.26"
[package.dependencies]
appdirs = ">=1.4.3,<2"
-distlib = ">=0.3.0,<1"
+distlib = ">=0.3.1,<1"
filelock = ">=3.0.0,<4"
six = ">=1.9.0,<2"
@@ -754,7 +754,7 @@ version = "0.2.5"
[[package]]
category = "dev"
description = "Backport of pathlib-compatible object wrapper for zip files"
-marker = "python_version >= \"3.6.1\" and python_version < \"3.7\" or python_version >= \"3.6.1\" and python_version < \"3.8\" and (python_version >= \"3.6.1\" and python_version < \"3.8\" or python_version < \"3.8\") or python_version >= \"3.6.1\" and python_version < \"3.8\" or python_version < \"3.8\""
+marker = "python_version >= \"3.6.1\" and python_version < \"3.7\" or python_version >= \"3.6.1\" and python_version < \"3.8\" or python_version < \"3.8\""
name = "zipp"
optional = false
python-versions = ">=3.6"
@@ -883,8 +883,8 @@ flake8 = [
{file = "flake8-3.8.3.tar.gz", hash = "sha256:f04b9fcbac03b0a3e58c0ab3a0ecc462e023a9faf046d57794184028123aa208"},
]
identify = [
- {file = "identify-1.4.21-py2.py3-none-any.whl", hash = "sha256:dac33eff90d57164e289fb20bf4e131baef080947ee9bf45efcd0da8d19064bf"},
- {file = "identify-1.4.21.tar.gz", hash = "sha256:c4d07f2b979e3931894170a9e0d4b8281e6905ea6d018c326f7ffefaf20db680"},
+ {file = "identify-1.4.23-py2.py3-none-any.whl", hash = "sha256:882c4b08b4569517b5f2257ecca180e01f38400a17f429f5d0edff55530c41c7"},
+ {file = "identify-1.4.23.tar.gz", hash = "sha256:f89add935982d5bc62913ceee16c9297d8ff14b226e9d3072383a4e38136b656"},
]
idna = [
{file = "idna-2.10-py2.py3-none-any.whl", hash = "sha256:b97d804b1e9b523befed77c48dacec60e6dcb0b5391d57af6a65a312a90648c0"},
@@ -903,8 +903,8 @@ importlib-resources = [
{file = "importlib_resources-3.0.0.tar.gz", hash = "sha256:19f745a6eca188b490b1428c8d1d4a0d2368759f32370ea8fb89cad2ab1106c3"},
]
isort = [
- {file = "isort-5.0.4-py3-none-any.whl", hash = "sha256:78661ad751751cb3c181d37302e175a0c644b3714877c073df058c596281d7fd"},
- {file = "isort-5.0.4.tar.gz", hash = "sha256:6ae9cf5414e416954e3421f861cbbfc099b3ace63cb270cc76c6670efd960a0a"},
+ {file = "isort-5.0.9-py3-none-any.whl", hash = "sha256:3d8e0d7678b66af1e3a6936f2a380a5d4f3faf4b1b38c6aaa4bed6695c6bdcde"},
+ {file = "isort-5.0.9.tar.gz", hash = "sha256:639b8084644ceb13a806f42d690273b9d844793ac2f515fbc575ba65dc044de0"},
]
jinja2 = [
{file = "Jinja2-2.11.2-py2.py3-none-any.whl", hash = "sha256:f0a4641d3cf955324a89c04f3d94663aa4d638abe8f733ecd3582848e1c37035"},
@@ -1130,8 +1130,8 @@ urllib3 = [
{file = "urllib3-1.25.9.tar.gz", hash = "sha256:3018294ebefce6572a474f0604c2021e33b3fd8006ecd11d62107a5d2a963527"},
]
virtualenv = [
- {file = "virtualenv-20.0.25-py2.py3-none-any.whl", hash = "sha256:ffffcb3c78a671bb3d590ac3bc67c081ea2188befeeb058870cba13e7f82911b"},
- {file = "virtualenv-20.0.25.tar.gz", hash = "sha256:f332ba0b2dfbac9f6b1da9f11224f0036b05cdb4df23b228527c2a2d5504aeed"},
+ {file = "virtualenv-20.0.26-py2.py3-none-any.whl", hash = "sha256:c11a475400e98450403c0364eb3a2d25d42f71cf1493da64390487b666de4324"},
+ {file = "virtualenv-20.0.26.tar.gz", hash = "sha256:e10cc66f40cbda459720dfe1d334c4dc15add0d80f09108224f171006a97a172"},
]
wcwidth = [
{file = "wcwidth-0.2.5-py2.py3-none-any.whl", hash = "sha256:beb4802a9cebb9144e99086eff703a642a13d6a0052920003a230f3294bbe784"},
diff --git a/pyproject.toml b/pyproject.toml
index 4324175..d91a911 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -4,7 +4,7 @@ version = "0.0.0"
description = "Interact with the daemon in the Linux Infrared Remote Control package"
authors = ["Eugene Triguba <eugenetriguba@gmail.com>"]
license = "MIT"
-readme = "README.md"
+readme = "README.rst"
repository = "https://github.com/eugenetriguba/lirc"
keywords = [
"LIRC",