Skip to content

Commit 40dd72b

Browse files
barbudorbarbudor
committed
adding files to comply with Adafruit Community Library Bundle
1 parent d0c7dd5 commit 40dd72b

7 files changed

Lines changed: 342 additions & 0 deletions

File tree

‎.travis.yml‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Travis CI configuration for automated .mpy file generation.
2+
# Author: Tony DiCola
3+
# License: Public Domain
4+
# This configuration will work with Travis CI (travis-ci.org) to automacially
5+
# build .mpy files for CircuitPython when a new tagged release is created. This
6+
# file is relatively generic and can be shared across multiple repositories by
7+
# following these steps:
8+
# 1. Copy this file into a .travis.yml file in the root of the repository.
9+
# 2. Change the deploy > file section below to list each of the .mpy files
10+
# that should be generated. The config will automatically look for
11+
# .py files with the same name as the source for generating the .mpy files.
12+
# Note that the .mpy extension should be lower case!
13+
# 3. Commit the .travis.yml file and push it to GitHub.
14+
# 4. Go to travis-ci.org and find the repository (it needs to be setup to access
15+
# your github account, and your github account needs access to write to the
16+
# repo). Flip the 'ON' switch on for Travis and the repo, see the Travis
17+
# docs for more details: https://docs.travis-ci.com/user/getting-started/
18+
# 5. Get a GitHub 'personal access token' which has at least 'public_repo' or
19+
# 'repo' scope: https://help.github.com/articles/creating-an-access-token-for-command-line-use/
20+
# Keep this token safe and secure! Anyone with the token will be able to
21+
# access and write to your GitHub repositories. Travis will use the token
22+
# to attach the .mpy files to the release.
23+
# 6. In the Travis CI settings for the repository that was enabled find the
24+
# environment variable editing page: https://docs.travis-ci.com/user/environment-variables/#Defining-Variables-in-Repository-Settings
25+
# Add an environment variable named GITHUB_TOKEN and set it to the value
26+
# of the GitHub personal access token above. Keep 'Display value in build
27+
# log' flipped off.
28+
# 7. That's it! Tag a release and Travis should go to work to add .mpy files
29+
# to the release. It takes about a 2-3 minutes for a worker to spin up,
30+
# build mpy-cross, and add the binaries to the release.
31+
language: generic
32+
33+
sudo: true
34+
35+
deploy:
36+
provider: releases
37+
api_key: $GITHUB_TOKEN
38+
file:
39+
- "barbudor_ina3221.mpy"
40+
- "barbudor_ina3221_lite.mpy"
41+
skip_cleanup: true
42+
on:
43+
tags: true
44+
45+
before_install:
46+
- sudo apt-get -yqq update
47+
- sudo apt-get install -y build-essential git python python-pip
48+
- git clone https://github.com/adafruit/circuitpython.git
49+
- make -C circuitpython/mpy-cross
50+
- export PATH=$PATH:$PWD/circuitpython/mpy-cross/
51+
- sudo pip install shyaml
52+
53+
before_deploy:
54+
- shyaml get-values deploy.file < .travis.yml | sed 's/.mpy/.py/' | xargs -L1 mpy-cross

‎CODE_OF_CONDUCT.md‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at support@adafruit.com. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at [http://contributor-covenant.org/version/1/4][version]
72+
73+
[homepage]: http://contributor-covenant.org
74+
[version]: http://contributor-covenant.org/version/1/4/

‎api.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
2+
.. If you created a package, create one automodule per module in the package.
3+
4+
.. automodule:: barbudor_ina3221
5+
:members:
6+
7+
.. automodule:: barbudor_ina3221_lite
8+
:members:

‎conf.py‎

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
# -*- coding: utf-8 -*-
2+
3+
import os
4+
import sys
5+
sys.path.insert(0, os.path.abspath('.'))
6+
7+
# -- General configuration ------------------------------------------------
8+
9+
# Add any Sphinx extension module names here, as strings. They can be
10+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
11+
# ones.
12+
extensions = [
13+
'sphinx.ext.autodoc',
14+
'sphinx.ext.intersphinx',
15+
'sphinx.ext.viewcode',
16+
]
17+
18+
intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'BusDevice': ('https://circuitpython.readthedocs.io/projects/bus_device/en/latest/', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}
19+
20+
# Add any paths that contain templates here, relative to this directory.
21+
templates_path = ['_templates']
22+
23+
source_suffix = '.rst'
24+
25+
# The master toctree document.
26+
master_doc = 'README'
27+
28+
# General information about the project.
29+
project = u'Barbudor INA3221 Library'
30+
copyright = u'2017 Jean-Michel Mercier'
31+
author = u'Jean-Michel Mercier'
32+
33+
# The version info for the project you're documenting, acts as replacement for
34+
# |version| and |release|, also used in various other places throughout the
35+
# built documents.
36+
#
37+
# The short X.Y version.
38+
version = u'1.0'
39+
# The full version, including alpha/beta/rc tags.
40+
release = u'1.0'
41+
42+
# The language for content autogenerated by Sphinx. Refer to documentation
43+
# for a list of supported languages.
44+
#
45+
# This is also used if you do content translation via gettext catalogs.
46+
# Usually you set "language" from the command line for these cases.
47+
language = None
48+
49+
# List of patterns, relative to source directory, that match files and
50+
# directories to ignore when looking for source files.
51+
# This patterns also effect to html_static_path and html_extra_path
52+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
53+
54+
# The reST default role (used for this markup: `text`) to use for all
55+
# documents.
56+
#
57+
default_role = "any"
58+
59+
# If true, '()' will be appended to :func: etc. cross-reference text.
60+
#
61+
add_function_parentheses = True
62+
63+
# The name of the Pygments (syntax highlighting) style to use.
64+
pygments_style = 'sphinx'
65+
66+
# If true, `todo` and `todoList` produce output, else they produce nothing.
67+
todo_include_todos = False
68+
69+
70+
# -- Options for HTML output ----------------------------------------------
71+
72+
# The theme to use for HTML and HTML Help pages. See the documentation for
73+
# a list of builtin themes.
74+
#
75+
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
76+
77+
if not on_rtd: # only import and set the theme if we're building docs locally
78+
try:
79+
import sphinx_rtd_theme
80+
html_theme = 'sphinx_rtd_theme'
81+
html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), '.']
82+
except:
83+
html_theme = 'default'
84+
html_theme_path = ['.']
85+
else:
86+
html_theme_path = ['.']
87+
88+
# Add any paths that contain custom static files (such as style sheets) here,
89+
# relative to this directory. They are copied after the builtin static files,
90+
# so a file named "default.css" will overwrite the builtin "default.css".
91+
html_static_path = ['_static']
92+
93+
# Output file base name for HTML help builder.
94+
htmlhelp_basename = 'BarbudorINA3221Librarydoc'
95+
96+
# -- Options for LaTeX output ---------------------------------------------
97+
98+
latex_elements = {
99+
# The paper size ('letterpaper' or 'a4paper').
100+
#
101+
# 'papersize': 'letterpaper',
102+
103+
# The font size ('10pt', '11pt' or '12pt').
104+
#
105+
# 'pointsize': '10pt',
106+
107+
# Additional stuff for the LaTeX preamble.
108+
#
109+
# 'preamble': '',
110+
111+
# Latex figure (float) alignment
112+
#
113+
# 'figure_align': 'htbp',
114+
}
115+
116+
# Grouping the document tree into LaTeX files. List of tuples
117+
# (source start file, target name, title,
118+
# author, documentclass [howto, manual, or own class]).
119+
latex_documents = [
120+
(master_doc, 'BarbudorINA3221Library.tex', u'Barbudor INA3221 Library Documentation',
121+
author, 'manual'),
122+
]
123+
124+
# -- Options for manual page output ---------------------------------------
125+
126+
# One entry per manual page. List of tuples
127+
# (source start file, name, description, authors, manual section).
128+
man_pages = [
129+
(master_doc, 'barbudorINA3221library', u'Barbudor INA3221 Library Documentation',
130+
[author], 1)
131+
]
132+
133+
# -- Options for Texinfo output -------------------------------------------
134+
135+
# Grouping the document tree into Texinfo files. List of tuples
136+
# (source start file, target name, title, author,
137+
# dir menu entry, description, category)
138+
texinfo_documents = [
139+
(master_doc, 'BarbudorINA3221Library', u'Barbudor INA3221 Library Documentation',
140+
author, 'BarbudorINA3221Library', 'One line description of project.',
141+
'Miscellaneous'),
142+
]

‎readthedocs.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
requirements_file: requirements.txt
2+

‎requirements.txt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Adafruit-Blinka
2+
adafruit-circuitpython-busdevice

‎setup.py‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
"""A setuptools based setup module.
2+
3+
See:
4+
https://packaging.python.org/en/latest/distributing.html
5+
https://github.com/pypa/sampleproject
6+
"""
7+
8+
# Always prefer setuptools over distutils
9+
from setuptools import setup, find_packages
10+
# To use a consistent encoding
11+
from codecs import open
12+
from os import path
13+
14+
here = path.abspath(path.dirname(__file__))
15+
16+
# Get the long description from the README file
17+
with open(path.join(here, 'README.rst'), encoding='utf-8') as f:
18+
long_description = f.read()
19+
20+
setup(
21+
name='barbudor-circuitpython-ina3221',
22+
23+
use_scm_version=True,
24+
setup_requires=['setuptools_scm'],
25+
26+
description='CircuitPython library for INA3221 triple channel current sensor.',
27+
long_description=long_description,
28+
long_description_content_type='text/x-rst',
29+
30+
# The project's main homepage.
31+
url='https://github.com/barbudor/CircuitPython_INA3221',
32+
33+
# Author details
34+
author='Barbudor',
35+
author_email='barbudor@barbudor.net',
36+
37+
install_requires=['Adafruit-Blinka', 'adafruit-circuitpython-busdevice'],
38+
39+
# Choose your license
40+
license='MIT',
41+
42+
# See https://pypi.python.org/pypi?%3Aaction=list_classifiers
43+
classifiers=[
44+
'Development Status :: 3 - Alpha',
45+
'Intended Audience :: Developers',
46+
'Topic :: Software Development :: Libraries',
47+
'Topic :: System :: Hardware',
48+
'License :: OSI Approved :: MIT License',
49+
'Programming Language :: Python :: 3',
50+
'Programming Language :: Python :: 3.4',
51+
'Programming Language :: Python :: 3.5',
52+
],
53+
54+
# What does your project relate to?
55+
keywords='current sensor I2C breakout hardware micropython circuitpython',
56+
57+
# You can just specify the packages manually here if your project is
58+
# simple. Or you can use find_packages().
59+
py_modules=['barbudor_ina3221'],
60+
)

0 commit comments

Comments
 (0)