Skip to content

Latest commit

 

History

History
61 lines (38 loc) · 2.54 KB

README.md

File metadata and controls

61 lines (38 loc) · 2.54 KB
Raw

Welcome to ft_utils!

We're excited to share this library with you, designed to help you build high-performance applications with Free Threaded Python.

License

ft_utils is open-source software, licensed under the permissive MIT license. You can find the full license terms in our LICENSE file.

Contributing and Code Standards

We'd love for you to contribute to ft_utils! To ensure that our codebase remains maintainable and efficient, we follow some simple guidelines. Please take a look at our CONTRIBUTING.md document for more information.

Extra Guidelines

In addition to these guidelines, we have a few extra rules to keep in mind:

  • Language: We use C11 and Python as our only programming languages. Build scripts can be in other languages.
  • Cross-Platform Compatibility: Our code must compile on Windows, Linux, and Mac(arm).
  • GIL and Free Threaded Python: All functionality should work seamlessly on both GIL and Free Threaded Python, although results may vary slightly between the two environments.
  • Unit Tests: Every feature must have at least one unit test to ensure it works correctly.
  • Benchmarks: It is best practice to write benchmarks for all new features to further test and to drive our aim of high performance.

Documentation

See to documentation.

Build And CI

Source Only

At the time of writing ft_utils is a source only distribution. You will need to build the wheel yourself.

Build The Wheel

You will need a source code version of CPython. To run for Free Threaded Python, at the time of writing, this means you will require CPython 3.13 and compile as 3.13t. This code will also compile under 3.12 but then you only get the GIL version.

Please ensure you are in a virtual environment. If you cannot, or do not wish to do this then you will need to coomment out the call to check_env() in setup.py.

Once you have everything in place, please execute setup.py as a python script:

python setup.py bdist_wheel

If this does not work due to networking then you might need use a proxy; for example:

https_proxy=http://fwdproxy:8080 python setup.py

CI

The code in ft_utils is built and tested interally within Meta. At the time of writing there is no external CI.

However, once installed you can test the code via python -m ft_utils.tests.test_run_all. This will not work if your current working directory is the ft_utils source director (due to name clash). This will run all the tests and benchmarks which are known good and report any failures.