Skip to content

Latest commit

 

History

History
188 lines (136 loc) · 7.58 KB

README.md

File metadata and controls

188 lines (136 loc) · 7.58 KB
Raw

About python-can-feedstock

Feedstock license: BSD-3-Clause

Home: https://github.com/hardbyte/python-can

Package license: LGPL-3.0-only

Summary: The can package provides controller area network support for Python developers

Development: https://github.com/hardbyte/python-can

Documentation: https://python-can.readthedocs.org/en/stable/

The C\ ontroller A\ rea N\ etwork is a bus standard designed to allow microcontrollers and devices to communicate with each other. It has priority based bus arbitration and reliable deterministic communication. It is used in cars, trucks, boats, wheelchairs and more.

The can package provides controller area network support for Python developers; providing common abstractions to different hardware devices, and a suite of utilities for sending and receiving messages on a can bus.

The library currently supports CPython as well as PyPy and runs on Mac, Linux and Windows.

============================== =========== Library Version Python

2.x 2.6+, 3.4+ 3.x 2.7+, 3.5+ 4.x (currently on develop) 3.7+ ============================== ===========

Features

  • common abstractions for CAN communication
  • support for many different backends (see the docs <https://python-can.readthedocs.io/en/stable/interfaces.html>__)
  • receiving, sending, and periodically sending messages
  • normal and extended arbitration IDs
  • CAN FD <https://en.wikipedia.org/wiki/CAN_FD>__ support
  • many different loggers and readers supporting playback: ASC (CANalyzer format), BLF (Binary Logging Format by Vector), CSV, SQLite and Canutils log
  • efficient in-kernel or in-hardware filtering of messages on supported interfaces
  • bus configuration reading from a file or from environment variables
  • command line tools for working with CAN buses (see the docs <https://python-can.readthedocs.io/en/stable/scripts.html>__)
  • more

Current build status

All platforms:

Current release info

Name Downloads Version Platforms
Conda Recipe Conda Downloads Conda Version Conda Platforms

Installing python-can

Installing python-can from the conda-forge channel can be achieved by adding conda-forge to your channels with:

conda config --add channels conda-forge
conda config --set channel_priority strict

Once the conda-forge channel has been enabled, python-can can be installed with conda:

conda install python-can

or with mamba:

mamba install python-can

It is possible to list all of the versions of python-can available on your platform with conda:

conda search python-can --channel conda-forge

or with mamba:

mamba search python-can --channel conda-forge

Alternatively, mamba repoquery may provide more information:

# Search all versions available on your platform:
mamba repoquery search python-can --channel conda-forge

# List packages depending on `python-can`:
mamba repoquery whoneeds python-can --channel conda-forge

# List dependencies of `python-can`:
mamba repoquery depends python-can --channel conda-forge

About conda-forge

Powered by NumFOCUS

conda-forge is a community-led conda channel of installable packages. In order to provide high-quality builds, the process has been automated into the conda-forge GitHub organization. The conda-forge organization contains one repository for each of the installable packages. Such a repository is known as a feedstock.

A feedstock is made up of a conda recipe (the instructions on what and how to build the package) and the necessary configurations for automatic building using freely available continuous integration services. Thanks to the awesome service provided by Azure, GitHub, CircleCI, AppVeyor, Drone, and TravisCI it is possible to build and upload installable packages to the conda-forge Anaconda-Cloud channel for Linux, Windows and OSX respectively.

To manage the continuous integration and simplify feedstock maintenance conda-smithy has been developed. Using the conda-forge.yml within this repository, it is possible to re-render all of this feedstock's supporting files (e.g. the CI configuration files) with conda smithy rerender.

For more information please check the conda-forge documentation.

Terminology

feedstock - the conda recipe (raw material), supporting scripts and CI configuration.

conda-smithy - the tool which helps orchestrate the feedstock. Its primary use is in the construction of the CI .yml files and simplify the management of many feedstocks.

conda-forge - the place where the feedstock and smithy live and work to produce the finished article (built conda distributions)

Updating python-can-feedstock

If you would like to improve the python-can recipe or build a new package version, please fork this repository and submit a PR. Upon submission, your changes will be run on the appropriate platforms to give the reviewer an opportunity to confirm that the changes result in a successful build. Once merged, the recipe will be re-built and uploaded automatically to the conda-forge channel, whereupon the built conda packages will be available for everybody to install and use from the conda-forge channel. Note that all branches in the conda-forge/python-can-feedstock are immediately built and any created packages are uploaded, so PRs should be based on branches in forks and branches in the main repository should only be used to build distinct package versions.

In order to produce a uniquely identifiable distribution:

  • If the version of a package is not being increased, please add or increase the build/number.
  • If the version of a package is being increased, please remember to return the build/number back to 0.

Feedstock Maintainers