jepler/circuitpython-org
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

latest content from kattni, update libraries.json values

Browse source
This commit is contained in:
Justin Cooper 2019-04-16 15:35:56 -05:00
parent 2e449f9bf7
commit 9493dc4acd
3 changed files with 107 additions and 43 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
_data/libraries.json
View file

@ -1,4 +1,5 @@
{
"updated_at": "2019-04-16T19:34:11Z",
"library_updates": {
"new": {
"Adafruit_CircuitPython_LIFX": "https://github.com/adafruit/Adafruit_CircuitPython_LIFX"
@ -19,5 +20,11 @@
"Adafruit_CircuitPython_Hue": {
"https://github.com/adafruit/Adafruit_CircuitPython_Hue/issues/2": "PyPi Setup"
}
}
},
"pull_requests": {
"link": "title"
},
"contributors": [
"@username", "@username2", "@username3"
]
}

56
libraries/contributing.html
View file

@ -10,25 +10,28 @@ permalink: /libraries/contributing
<div class="content">
<h1>Contributing</h1>
<p>
This is the place to stay up-to-date on the state of the CircuitPython
libraries. We will be updating this issue each week with the most recent
status from the wonderful Adabot!
If you'd like to contribute to the CircuitPython project, the CircuitPython
libraries are a great way to begin. This page is updated weekly with status
information from the CircuitPython libraries, including open issues and
repo-level issues.
</p>
<p>
If you'd like to contribute, CircuitPython libraries are a great place to
start. Have an idea for a new driver? File an issue here on the
<a href="https://github.com/adafruit/circuitpython/issues">CircuitPython</a>
repo! Interested in helping with current libraries? This
issue is the place to start. We've included open issues from the library
issue lists, and details about repo-level issues that need to be
addressed. We have a guide on
<a href="https://learn.adafruit.com/contribute-to-circuitpython-with-git-and-github">contributing to CircuitPython with Git and Github</a>
if you need help getting started. You can also find us in the
#circuitpython channel on the
<a href="https://adafru.it/discord">Adafruit Discord.</a> Feel free to
contact Kattni (@kattni) with any questions.
If this is your first time contributing, or you'd
like to see our recommended contribution workflow, we have a guide on
<a href="https://learn.adafruit.com/contribute-to-circuitpython-with-git-and-github">Contributing to CircuitPython with Git and Github</a>.
You can also find us in the #circuitpython channel on the
<a href="https://adafru.it/discord">Adafruit Discord</a>.
</p>
<p>
Have an idea for a new driver or library?
<a href="https://github.com/adafruit/circuitpython/issues">File an issue on the CircuitPython repo!</a>
</p>
<!-- another subheader here -->
<h2>Current Status for Week of {{ site.data.libraries.updated_at | date: "%a, %b %d, %Y" }}</h2>
<p>
This is the current status of open pull requests and issues across all of the library repos.
</p>
<!-- open PRs should come before Open Issues -->
<div class="libraries open-issues">
<h3>Open Issues</h3>
<ul>
@ -44,5 +47,26 @@ permalink: /libraries/contributing
{% endfor %}
</ul>
</div>
<!-- I think I managed to get this in the right div at the right indent level... -->
<h2>Repo-Level Issues</h2>
<p>
The following are further issues we've identified with the library repositories. Most of these
are changes that can be made via a pull request, however there are a few checks reported here
that require changes to GitHub settings. If you are interested in addressing any of these issues,
please feel free to contact us with any questions.
</p>
<!-- is my use of <code> accurate in the paragraph below? The intention is to format the file names. -->
<!-- or would they look better bold and not code formatted? -->
<p>
If you're looking for a Good First Issue to begin contributing, consider the two issues related to
example naming: "Example file(s) missing sensor/library name." and "Missing simpletest example."
Every repo should have a <code>libraryname_simpletest.py</code> file in the examples folder at a
minimum. Any other included examples should be prefixed with <code>libraryname_</code> so all
examples found in any given repo folder start with the library name followed by an underscore.
The GitHub end of things is a simple fix, however, please be aware <b>many examples are linked in
Learn guides</b>. You should mention in your pull request that it is possible that guides will
require updating to match the new example name.
</p>
<!-- The rest of the script info goes here -->
</div>
</div>

85
libraries/index.html
View file

@ -8,76 +8,109 @@ permalink: /libraries
<div class="content">
<h1>CircuitPython Libraries</h1>
<p>
These are libraries and drivers available in separate GitHub repos.
They are designed for use with CircuitPython and may or may not work with MicroPython.
The CircuitPython Library Bundle contains all current libraries available for
CircuitPython. They are designed for use with CircuitPython and may or may not
work with MicroPython. The bundle options are explained below.
<p>
CircuitPython libraries are separate files designed to work with CircuitPython code.
CircuitPython programs require a lot of information to run. CircuitPython is so simple
to use because most of this information is processed in the background and stored in
libraries. Some libraries are built into CircuitPython. Others are downloaded and
stored on your CIRCUITPY drive in a folder called lib.
</p>
<p>
The full list of all the libraries contained in the following bundles
can be found on our
<a href="https://circuitpython.readthedocs.io/projects/bundle/en/latest/drivers.html">libraries page</a>
on Read the Docs.
<h2>Download Instructions</h2>
The full list of all the CircuitPython libraries contained in the following bundles
can be found on the
<a href="https://circuitpython.readthedocs.io/projects/bundle/en/latest/drivers.html">libraries page</a>.
<h2>Download and Installation Instructions</h2>
<p>
The libraries in each release are compiled for all recent major versions
of CircuitPython. Please download the one that matches the major version
of your CircuitPython. For example, if you are running 3.0.0 you should
download the 3.x bundle.
The libraries in each release are compiled to .mpy for all recent major versions
of CircuitPython. Please download the bundle that matches the major version
of your CircuitPython. For example, if you are running 4.0.0 you should
download the 4.x bundle. The .mpy files are designed to take up less space on
your CIRCUITPY drive. Unless you have a specific reason, choose the appropiate
.mpy library bundle!
</p>
<p>
To install, simply download the matching zip file, unzip it, and copy
the lib folder onto your CIRCUITPY drive. Non-express boards such as the
Trinket M0, Gemma M0 and Feather M0 Basic will need to selectively copy
files over.
To install, download the appropriate bundle for your version of CircuitPython.
Unzip the file, open the resulting folder and find the lib folder. Open the lib
folder and find the library files you need to load. Create a lib folder on your
CIRCUITPY drive. Copy the individual library files you need to the lib folder
on your CIRCUITPY drive.
</p>
<p>
You can always find the <a href="https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases/latest">latest releases of the libraries bundle</a>
You can always find the
<a href="https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases/latest">latest releases of the libraries bundle</a>
on GitHub.
<div class="release-section">
<div id="adafruit-circuitpython-bundle-4.x-mpy">
<h3>Bundle Version 4.x</h3>
<p>
Info about 4.x here
This bundle is built for use with CircuitPython 4.x.x. If you are using
CircuitPython 4, please download this bundle.
</p>
</div>
<div id="adafruit-circuitpython-bundle-3.x-mpy">
<h3>Bundle Version 3.x</h3>
<p>
Info about 3.x here
This bundle is built for use with CircuitPython 3.x.x. If you are using
CircuitPython 3, please download this bundle.
</p>
</div>
<div id="adafruit-circuitpython-bundle-py">
<h3>Bundle Version py</h3>
<p>
Info about py here
This bundle is the uncompiled source code for every library. This bundle is
not intended for general use! This bundle is only recommended if you need to
edit a library file. This bundle works with all versions of CircuitPython.
</p>
</div>
<div id="adafruit-circuitpython-bundle-examples">
<h3>Bundle Examples</h3>
<p>
Info about examples here
Every CircuitPython library has examples to go along with it. This bundle
contains every library example. This bundle will have examples that
require the latest version of CircuitPython, and therefore contains files
that may not work with all versions.
</p>
</div>
</div>
<h2>Contributing</h2>
<p>Quick bit about contributing (TODO TEXT FROM KATTNI)</p>
<p class="libraries new">
<p>
If you'd like to contribute to the CircuitPython project, the CircuitPython
libraries are a great way to begin. Everyone is welcome to contribute!
Regardless of your experience level, we have many resources to get you
started. Check out the link below for more detailed information about how
you can contribute to CircuitPython libraries!
</p>
<!-- (can we even include the date like this?) -->
<h2>Library Activity for Week of {{ site.data.libraries.updated_at | date: "%a, %b %d, %Y" }}</h2>
<p>
Thank you to this week's contributors!
</p>
<!-- pull the first section of the script report into this spot - (the PR's merged authors/reviewers and Issues opened/closed bit) -->
<p>
These are the new and updated libraries from the past week.
</p>
<div class="libraries new">
<h3>New Libraries</h3>
<ul>
{% for library in site.data.libraries.library_updates.new %}
<li><a href="{{library[1]}}">{{library[0]}}</a></li>
{% endfor %}
</ul>
</p>
<p class="libraries updated">
</div>
<div class="libraries updated">
<h3>Updated Libraries</h3>
<ul>
{% for library in site.data.libraries.library_updates.updated %}
<li><a href="{{library[1]}}">{{library[0]}}</a></li>
{% endfor %}
</ul>
</p>
</div>
<p>
<a href="{{ "/libraries/contributing" | relative_url }}">Contributing link</a>. (TODO TEXT FROM KATTNI)</p>
Find out more about how you can
<a href="{{ "/libraries/contributing" | relative_url }}">contribute to CircuitPython libraries</a>.</p>
</p>
</div>
</div>