Code Monkey home page Code Monkey logo

kcl.py's Introduction

kcl.py

Python bindings to the rust kcl-lib crate.

Usage

The tests.py file contains examples of how to use the library.

Development

We use maturin for this project.

You can either download binaries from the latest release or install it with pipx:

pipx install maturin

Note

pip install maturin should also work if you don't want to use pipx.

There are four main commands:

  • maturin publish builds the crate into python packages and publishes them to pypi.
  • maturin build builds the wheels and stores them in a folder (target/wheels by default), but doesn't upload them. It's possible to upload those with twine or maturin upload.
  • maturin develop builds the crate and installs it as a python module directly in the current virtualenv. Note that while maturin develop is faster, it doesn't support all the feature that running pip install after maturin build supports.

pyo3 bindings are automatically detected. maturin doesn't need extra configuration files and doesn't clash with an existing setuptools-rust or milksnake configuration.

Releasing a new version

  1. Make sure the Cargo.toml has the new version you want to release.
  2. Run make tag this is just an easy command for making a tag formatted correctly with the version.
  3. Push the tag (the result of make tag gives instructions for this)
  4. Everything else is triggered from the tag push. Just make sure all the tests pass on the main branch before making and pushing a new tag.

kcl.py's People

Contributors

jessfraz avatar dependabot[bot] avatar

Stargazers

Robin Heinemann avatar

Watchers

Adam Sunderland avatar Mike Sager avatar Ryan Barton avatar Adam Chalmers avatar David Harvey-Macaulay avatar Vonni Williams avatar Pierre Jacquier avatar Ben Crabbe avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.