# FindPython
_A utility to find python versions on your system._
[](https://github.com/frostming/findpython/actions/workflows/ci.yml)
[](https://pypi.org/project/findpython)
[](https://pypi.org/project/findpython)
[](https://github.com/frostming/findpython)
## Description
This library is a rewrite of [pythonfinder] project by [@techalchemy][techalchemy].
It simplifies the whole code structure while preserving most of the original features.
[pythonfinder]: https://github.com/sarugaku/pythonfinder
[techalchemy]: https://github.com/techalchemy
## Installation
FindPython can be used in both Python and Rust projects.
To install FindPython in Python:
```bash
pip install findpython
```
To install FindPython in Rust:
```bash
cargo install findpyhton
```
Or use FindPython library in a Rust project:
```bash
cargo add findpython
```
Expand this section to see findpython's availability in the package ecosystem
## Python Usage
```python
>>> import findpython
>>> findpython.find(3, 9) # Find by major and minor version
>>> findpython.find("3.9") # Find by version string
>>> findpython.find("3.9-32") # Find by version string and architecture
>>> findpython.find(name="python3") # Find by executable name
>>> findpython.find("python3") # Find by executable name without keyword argument, same as above
>>> findpython.find_all(major=3, minor=9) # Same arguments as `find()`, but return all matches
[,
]
```
## Rust Usage
```rust
use findpython::{Finder, MatchOptions};
fn main() {
let finder = Finder::default();
// Find by major and minor version
let py = finder.find(MatchOptions::default().major(3).minor(10)).unwrap();
println!("{:?}", py);
// Find all matches
let all_pythons = finder.find_all();
println!("{:?}", all_pythons);
}
```
## CLI Usage
In addition, FindPython provides a CLI interface to find python versions:
```
Find python executables on your system
Usage: findpython [OPTIONS] [VERSION_SPEC]
Arguments:
[VERSION_SPEC] The version spec to find, e.g. 3|3.8|python3
Options:
-a, --all Return all matching Python versions
--resolve-symlinks Resolve symlinks and remove duplicate results
--no-same-file Remove duplicate results that are the same binary
--no-same-python Remove duplicate results that wrap the same Python interpreter
--providers Select provider names(comma-separated) to use
-o, --output