py-rattler 0.13.1__tar.gz → 0.15.0__tar.gz

py_rattler-0.15.0/Cargo.toml

@@ -0,0 +1,207 @@
+[workspace]
+members = ["crates/*", "tools/*"]
+resolver = "2"
+
+# See: https://docs.rs/insta/latest/insta/#optional-faster-runs
+[profile.dev.package.insta]
+opt-level = 3
+
+[workspace.package]
+categories = ["development-tools"]
+homepage = "https://github.com/conda/rattler"
+repository = "https://github.com/conda/rattler"
+license = "BSD-3-Clause"
+edition = "2021"
+readme = "README.md"
+
+[workspace.metadata.release]
+allow-branch = ["main"]
+consolidate-commits = true
+tag-prefix = ""
+
+[profile.bench]
+lto = true
+
+[workspace.dependencies]
+anyhow = "1.0.98"
+archspec = "0.1.3"
+assert_matches = "1.5.0"
+async-compression = { version = "0.4", features = [
+  "gzip",
+  "tokio",
+  "bzip2",
+  "zstd",
+] }
+async-fd-lock = "0.2.0"
+fs4 = "0.13.1"
+async-trait = "0.1.88"
+axum = { version = "0.8.4", default-features = false, features = [
+  "tokio",
+  "http1",
+] }
+base64 = "0.22.1"
+bindgen = "0.72.0"
+blake2 = "0.10.6"
+bytes = "1.10.1"
+bzip2 = "0.6.0"
+cache_control = "0.2.0"
+cfg-if = "1.0"
+chrono = { version = "0.4.41", default-features = false, features = [
+  "std",
+  "serde",
+  "alloc",
+] }
+clap = { version = "4.5.38", features = ["derive"] }
+clap-verbosity-flag = "3.0.3"
+cmake = "0.1.54"
+console = { version = "0.15.11", features = ["windows-console-colors"] }
+criterion = "0.6"
+dashmap = "6.1.0"
+difference = "2.0.0"
+digest = "0.10.7"
+dirs = "6.0.0"
+dunce = "1.0.5"
+enum_dispatch = "0.3.13"
+fs-err = { version = "3.1.0" }
+fslock = "0.2.1"
+futures = "0.3.31"
+futures-util = "0.3.31"
+fxhash = "0.2.1"
+# lots of other crates are still stuck on older version which breaks `deserialize`
+generic-array = "0.14.7"
+getrandom = { version = "0.3.3", default-features = false }
+glob = "0.3.2"
+google-cloud-auth = { version = "0.21.0", default-features = false }
+aws-config = { version = "=1.5.18", default-features = false, features = [
+  "rt-tokio",
+  "rustls",
+  "sso",
+  "credentials-process",
+] }
+aws-sdk-s3 = { version = "1.85.0", default-features = false, features = [
+  "rt-tokio",
+  "rustls",
+  "sigv4a",
+] }
+hex = "0.4.3"
+hex-literal = "1.0.0"
+http = "1.3"
+http-cache-semantics = "2.1.0"
+humansize = "2.1.3"
+humantime = "2.2.0"
+indexmap = "2.9.0"
+indicatif = "0.17.11"
+insta = { version = "1.43.1" }
+itertools = "0.14.0"
+json-patch = "4.0.0"
+keyring = "3.6.2"
+lazy-regex = "3.4.1"
+libc = { version = "0.2" }
+libloading = "0.8.7"
+libz-sys = { version = "1.1.22", default-features = false }
+md-5 = "0.10.6"
+memchr = "2.7.4"
+memmap2 = "0.9.5"
+miette = "7.6.0"
+netrc-rs = "0.1.2"
+nom = "8.0.0"
+nom-language = "0.1.0"
+num_cpus = "1.16.0"
+opendal = { version = "0.53.3", default-features = false }
+once_cell = "1.21.3"
+parking_lot = "0.12.3"
+pathdiff = "0.2.3"
+pep440_rs = { version = "0.7.3" }
+pep508_rs = { version = "0.9.2" }
+percent-encoding = "2.3.1"
+pin-project-lite = "0.2.16"
+plist = "1"
+purl = { version = "0.1.6", features = ["serde"] }
+quote = "1.0.40"
+rand = "0.9.1"
+rayon = "1.10.0"
+reflink-copy = "0.1.26"
+regex = "1.11.1"
+reqwest = { version = "0.12.15", default-features = false }
+reqwest-middleware = "0.4.2"
+reqwest-retry = "0.7.0"
+resolvo = { version = "0.9.1" }
+# hold back at 0.4.0 until `reqwest-retry` is updated
+retry-policies = { version = "0.4.0", default-features = false }
+rmp-serde = { version = "1.3.0" }
+rstest = { version = "0.25.0" }
+rstest_reuse = "0.7.0"
+simd-json = { version = "0.15.1", features = ["serde_impl"] }
+self_cell = "1.2.0"
+serde = { version = "1.0.219" }
+serde_json = { version = "1.0.140" }
+serde_repr = "0.1"
+serde-value = "0.7.0"
+serde_with = "3.12.0"
+serde_yaml = "0.9.34"
+serde-untagged = "0.1.7"
+sha2 = "0.10.9"
+shlex = "1.3.0"
+similar-asserts = "1.7.0"
+smallvec = { version = "1.15.0", features = [
+  "serde",
+  "const_new",
+  "const_generics",
+  "union",
+] }
+strum = { version = "0.27.1", features = ["derive"] }
+superslice = "1.0.0"
+syn = "2.0.101"
+sysinfo = "0.35.1"
+tar = "0.4.44"
+tempdir = "0.3.7"
+tempfile = "3.20.0"
+temp-env = { version = "0.3.6", features = ["async_closure"] }
+test-log = "0.2.17"
+thiserror = "2.0"
+tokio = { version = "1.45.1", default-features = false }
+tokio-stream = "0.1.17"
+tokio-util = "0.7.15"
+toml = "0.8.23"
+tower = { version = "0.5.2", default-features = false }
+tower-http = { version = "0.6.4", default-features = false }
+tracing = "0.1.41"
+tracing-subscriber = { version = "0.3.19", default-features = false }
+tracing-test = { version = "0.2.5" }
+trybuild = { version = "1.0.105" }
+typed-path = { version = "0.11.0" }
+url = { version = "2.5.4" }
+unicode-normalization = "0.1.24"
+uuid = { version = "1.17.0", default-features = false }
+walkdir = "2.5.0"
+wasmtimer = "0.4.1"
+which = "8.0.0"
+windows-sys = { version = "0.60.0", default-features = false }
+winver = { version = "1.0.0" }
+zip = { version = ">=3.0.0,<4.1", default-features = false }
+zstd = { version = "0.13.3", default-features = false }
+
+# These are the all the crates defined in the workspace. We pin all of them together because they are always updated in tendem.
+file_url = { path = "crates/file_url", version = "=0.2.5", default-features = false }
+rattler = { path = "crates/rattler", version = "=0.34.5", default-features = false }
+rattler_cache = { path = "crates/rattler_cache", version = "=0.3.24", default-features = false }
+rattler_conda_types = { path = "crates/rattler_conda_types", version = "=0.35.4", default-features = false }
+rattler_config = { path = "crates/rattler_config", version = "=0.2.1", default-features = false }
+rattler_digest = { path = "crates/rattler_digest", version = "=1.1.4", default-features = false }
+rattler_index = { path = "crates/rattler_index", version = "=0.24.2", default-features = false }
+rattler_libsolv_c = { path = "crates/rattler_libsolv_c", version = "=1.2.3", default-features = false }
+rattler_lock = { path = "crates/rattler_lock", version = "=0.23.9", default-features = false }
+rattler_macros = { path = "crates/rattler_macros", version = "=1.0.11", default-features = false }
+rattler_menuinst = { path = "crates/rattler_menuinst", version = "=0.2.15", default-features = false }
+rattler_networking = { path = "crates/rattler_networking", version = "=0.25.4", default-features = false }
+rattler_pty = { path = "crates/rattler_pty", version = "=0.2.4", default-features = false }
+rattler_redaction = { path = "crates/rattler_redaction", version = "=0.1.12", default-features = false }
+rattler_package_streaming = { path = "crates/rattler_package_streaming", version = "=0.22.43", default-features = false }
+rattler_repodata_gateway = { path = "crates/rattler_repodata_gateway", version = "=0.23.5", default-features = false }
+rattler_sandbox = { path = "crates/rattler_sandbox", version = "=0.1.10", default-features = false }
+rattler_shell = { path = "crates/rattler_shell", version = "=0.24.2", default-features = false }
+rattler_solve = { path = "crates/rattler_solve", version = "=2.1.4", default-features = false }
+rattler_virtual_packages = { path = "crates/rattler_virtual_packages", version = "=2.0.17", default-features = false }
+
+# This is also a rattler crate, but we only pin it to minor version
+simple_spawn_blocking = { path = "crates/simple_spawn_blocking", version = "1.1", default-features = false }

py_rattler-0.15.0/PKG-INFO

@@ -0,0 +1,213 @@
+Metadata-Version: 2.4
+Name: py-rattler
+Version: 0.15.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Typing :: Typed
+Summary: A blazing fast library to work with the conda ecosystem
+Author-email: Bas Zalmstra <zalmstra.bas@gmail.com>, Tarun Pratap Singh <pratapsinghtarun9@gmail.com>
+License: BSD-3-Clause
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Homepage, https://github.com/conda/rattler
+Project-URL: Documentation, https://conda.github.io/rattler/py-rattler/
+Project-URL: Repository, https://github.com/conda/rattler
+Project-URL: Issues, https://github.com/conda/rattler/labels/python-bindings
+
+<a href="https://github.com/conda/rattler/">
+    <picture>
+      <source srcset="https://github.com/user-attachments/assets/6f3f05bc-6363-4974-9517-fe5c0fcffd1a" type="image/jpeg">
+      <source srcset="https://github.com/user-attachments/assets/dc30403d-6392-460a-b923-986c2164ef79" type="image/webp">
+      <source srcset="https://github.com/user-attachments/assets/bfd64756-061d-49f5-af4e-388743bdb855" type="image/png">
+      <img src="https://github.com/user-attachments/assets/bfd64756-061d-49f5-af4e-388743bdb855" alt="banner">
+    </picture>
+</a>
+
+# Rattler: Rust crates for fast handling of conda packages
+
+![License][license-badge]
+[![Build Status][build-badge]][build]
+[![Project Chat][chat-badge]][chat-url]
+[![Pixi Badge][pixi-badge]][pixi-url]
+[![docs main][docs-main-badge]][docs-main]
+[![python docs main][py-docs-main-badge]][py-docs-main]
+
+[license-badge]: https://img.shields.io/badge/license-BSD--3--Clause-blue?style=flat-square
+[build-badge]: https://img.shields.io/github/actions/workflow/status/conda/rattler/rust-compile.yml?style=flat-square&branch=main
+[build]: https://github.com/conda/rattler/actions
+[chat-badge]: https://img.shields.io/discord/1082332781146800168.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2&style=flat-square
+[chat-url]: https://discord.gg/kKV8ZxyzY4
+[docs-main-badge]: https://img.shields.io/badge/rust_docs-main-yellow.svg?style=flat-square
+[docs-main]: https://conda.github.io/rattler
+[py-docs-main-badge]: https://img.shields.io/badge/python_docs-main-yellow.svg?style=flat-square
+[py-docs-main]: https://conda.github.io/rattler/py-rattler
+[pixi-badge]:https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/prefix-dev/pixi/main/assets/badge/v0.json&style=flat-square
+[pixi-url]: https://pixi.sh
+
+Rattler is a library that provides common functionality used within the conda ecosystem ([what is conda & conda-forge?](#what-is-conda--conda-forge)).
+The goal of the library is to enable programs and other libraries to easily interact with the conda ecosystem without being dependent on Python.
+Its primary use case is as a library that you can use to provide conda related workflows in your own tools.
+
+Rattler is written in Rust and tries to provide a clean API to its functionalities (see: [Components](#components)).
+With the primary goal in mind we aim to provide bindings to different languages to make it easy to integrate Rattler in non-rust projects.
+
+Rattler is actively used by [pixi](https://github.com/prefix-dev/pixi), [rattler-build](https://github.com/prefix-dev/rattler-build), and the https://prefix.dev backend.
+
+## Showcase
+
+This repository also contains a binary (use `cargo run` to try) that shows some of the capabilities of the library.
+This is an example of installing an environment containing `cowpy` and all its dependencies _from scratch_ (including Python!):
+
+![Installing an environment](https://github.com/conda/rattler/assets/4995967/c7946f6e-28a9-41ef-8836-ef4b4c94d273)
+
+## Python and Javascript bindings
+
+You can invoke `rattler` from Python or Javascript via our powerful bindings to solve, install and run commands in conda environments. Rattler offers you the fastest and cleanest Python bindings to the conda ecosystem.
+
+### Python
+
+To install the Python bindings, you can use pip or conda:
+
+```bash
+pip install py-rattler
+# or
+conda install -c conda-forge py-rattler
+```
+
+You can find the extensive documentation for the Python bindings [here](https://conda.github.io/rattler/py-rattler/).
+
+<details>
+  <summary>Example usage of rattler from Python</summary>
+The Python bindings to rattler are designed to be used with `asyncio`. You can access the raw power of the rattler library to solve environments, install packages, and run commands in the installed environments.
+
+```python
+import asyncio
+import tempfile
+
+from rattler import solve, install, VirtualPackage
+
+async def main() -> None:
+    # Start by solving the environment.
+    #
+    # Solving is the process of going from specifications of package and their
+    # version requirements to a list of concrete packages.
+    print("started solving the environment")
+    solved_records = await solve(
+        # Channels to use for solving
+        channels=["conda-forge"],
+        # The specs to solve for
+        specs=["python ~=3.12.0", "pip", "requests 2.31.0"],
+        # Virtual packages define the specifications of the environment
+        virtual_packages=VirtualPackage.detect(),
+    )
+    print("solved required dependencies")
+
+    # Install the packages into a new environment (or updates it if it already
+    # existed).
+    env_path = tempfile.mkdtemp()
+    await install(
+        records=solved_records,
+        target_prefix=env_path,
+    )
+
+    print(f"created environment: {env_path}")
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+</details>
+
+### Javascript
+
+To use the Javascript bindings, you can install the `@conda-org/rattler` package via npm. rattler is compiled to WebAssembly and can be used in the browser or in Node.js.
+
+```bash
+npm install @conda-org/rattler
+```
+
+Using rattler from Javascript is useful to get access to the same version comparison functions as used throughout the conda ecosystem. It is also used as part of [`mambajs`](https://github.com/emscripten-forge/mambajs) which uses the rattler library to solve and install packages from the emscripten-forge channel _in the browser_.
+
+
+## Give it a try!
+
+Before you begin, make sure you have the following prerequisites:
+- A recent version of [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
+- A recent version of [pixi](https://github.com/prefix-dev/pixi)
+
+Follow these steps to clone, compile, and run the rattler project:
+```shell
+# Clone the rattler repository along with its submodules:
+git clone --recursive https://github.com/conda/rattler.git
+cd rattler
+
+# Compile and execute rattler to create a JupyterLab instance:
+pixi run rattler create jupyterlab
+```
+
+The above command will execute the `rattler` executable in release mode.
+It will download and install an environment into the `.prefix` folder that contains [`jupyterlab`](https://jupyterlab.readthedocs.io/en/stable/getting_started/overview.html) and all the dependencies required to run it (like `python`)
+
+Run the following command to start jupyterlab:
+
+```shell
+# on windows
+.\.prefix\Scripts\jupyter-lab.exe
+
+# on linux or macOS
+ ./.prefix/bin/jupyter-lab
+```
+
+Voila!
+You have a working installation of jupyterlab installed on your system!
+You can of course install any package you want this way.
+Try it!
+
+## Contributing 😍
+
+We would love to have you contribute!
+See the CONTRIBUTION.md for more info. For questions, requests or a casual chat, we are very active on our discord server.
+You can [join our discord server via this link][chat-url].
+
+
+## Components
+
+Rattler consists of several crates that provide different functionalities.
+
+* **rattler_conda_types**: foundational types for all datastructures used within the conda eco-system.
+* **rattler_package_streaming**: provides functionality to download, extract and create conda package archives.
+* **rattler_repodata_gateway**: downloads, reads and processes information about existing conda packages from an index.
+* **rattler_shell**: code to activate an existing environment and run programs in it.
+* **rattler_solve**: a backend agnostic library to solve the package satisfiability problem.
+* **rattler_virtual_packages**: a crate to detect system capabilities.
+* **rattler_index**: create local conda channels from local packages.
+* **rattler**: functionality to create complete environments from scratch using the crates above.
+* **rattler-lock**: a library to create and parse lockfiles for conda environments.
+* **rattler-networking**: common functionality for networking, like authentication, mirroring and more.
+* **rattler-bin**: an example of a package manager using all the crates above (see: [showcase](#showcase))
+
+You can find these crates in the `crates` folder.
+
+Additionally, we provide Python bindings for most of the functionalities provided by the above crates.
+A python package `py-rattler` is available on [conda-forge](https://prefix.dev/channels/conda-forge/packages/py-rattler) and [PyPI](https://pypi.org/project/py-rattler/).
+Documentation for the python bindings can be found [here](https://conda.github.io/rattler/py-rattler).
+
+## What is conda & conda-forge?
+
+The conda ecosystem provides **cross-platform**, **binary** packages that you can use with **any programming language**.
+`conda` is an open-source package management system and environment management system that can install and manage multiple versions of software packages and their dependencies.
+`conda` is written in Python.
+The aim of Rattler is to provide all functionality required to work with the conda ecosystem from Rust.
+Rattler is not a reimplementation of `conda`.
+`conda` is a package management tool.
+Rattler is a _library_ to work with the conda ecosystem from different languages and applications.
+For example, it powers the backend of https://prefix.dev.
+
+`conda-forge` is a community-driven effort to bring new and existing software into the conda ecosystem.
+It provides _tens-of-thousands of up-to-date_ packages that are maintained by a community of contributors.
+For an overview of available packages see https://prefix.dev.
+

py_rattler-0.15.0/README.md

@@ -0,0 +1,192 @@
+<a href="https://github.com/conda/rattler/">
+    <picture>
+      <source srcset="https://github.com/user-attachments/assets/6f3f05bc-6363-4974-9517-fe5c0fcffd1a" type="image/jpeg">
+      <source srcset="https://github.com/user-attachments/assets/dc30403d-6392-460a-b923-986c2164ef79" type="image/webp">
+      <source srcset="https://github.com/user-attachments/assets/bfd64756-061d-49f5-af4e-388743bdb855" type="image/png">
+      <img src="https://github.com/user-attachments/assets/bfd64756-061d-49f5-af4e-388743bdb855" alt="banner">
+    </picture>
+</a>
+
+# Rattler: Rust crates for fast handling of conda packages
+
+![License][license-badge]
+[![Build Status][build-badge]][build]
+[![Project Chat][chat-badge]][chat-url]
+[![Pixi Badge][pixi-badge]][pixi-url]
+[![docs main][docs-main-badge]][docs-main]
+[![python docs main][py-docs-main-badge]][py-docs-main]
+
+[license-badge]: https://img.shields.io/badge/license-BSD--3--Clause-blue?style=flat-square
+[build-badge]: https://img.shields.io/github/actions/workflow/status/conda/rattler/rust-compile.yml?style=flat-square&branch=main
+[build]: https://github.com/conda/rattler/actions
+[chat-badge]: https://img.shields.io/discord/1082332781146800168.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2&style=flat-square
+[chat-url]: https://discord.gg/kKV8ZxyzY4
+[docs-main-badge]: https://img.shields.io/badge/rust_docs-main-yellow.svg?style=flat-square
+[docs-main]: https://conda.github.io/rattler
+[py-docs-main-badge]: https://img.shields.io/badge/python_docs-main-yellow.svg?style=flat-square
+[py-docs-main]: https://conda.github.io/rattler/py-rattler
+[pixi-badge]:https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/prefix-dev/pixi/main/assets/badge/v0.json&style=flat-square
+[pixi-url]: https://pixi.sh
+
+Rattler is a library that provides common functionality used within the conda ecosystem ([what is conda & conda-forge?](#what-is-conda--conda-forge)).
+The goal of the library is to enable programs and other libraries to easily interact with the conda ecosystem without being dependent on Python.
+Its primary use case is as a library that you can use to provide conda related workflows in your own tools.
+
+Rattler is written in Rust and tries to provide a clean API to its functionalities (see: [Components](#components)).
+With the primary goal in mind we aim to provide bindings to different languages to make it easy to integrate Rattler in non-rust projects.
+
+Rattler is actively used by [pixi](https://github.com/prefix-dev/pixi), [rattler-build](https://github.com/prefix-dev/rattler-build), and the https://prefix.dev backend.
+
+## Showcase
+
+This repository also contains a binary (use `cargo run` to try) that shows some of the capabilities of the library.
+This is an example of installing an environment containing `cowpy` and all its dependencies _from scratch_ (including Python!):
+
+![Installing an environment](https://github.com/conda/rattler/assets/4995967/c7946f6e-28a9-41ef-8836-ef4b4c94d273)
+
+## Python and Javascript bindings
+
+You can invoke `rattler` from Python or Javascript via our powerful bindings to solve, install and run commands in conda environments. Rattler offers you the fastest and cleanest Python bindings to the conda ecosystem.
+
+### Python
+
+To install the Python bindings, you can use pip or conda:
+
+```bash
+pip install py-rattler
+# or
+conda install -c conda-forge py-rattler
+```
+
+You can find the extensive documentation for the Python bindings [here](https://conda.github.io/rattler/py-rattler/).
+
+<details>
+  <summary>Example usage of rattler from Python</summary>
+The Python bindings to rattler are designed to be used with `asyncio`. You can access the raw power of the rattler library to solve environments, install packages, and run commands in the installed environments.
+
+```python
+import asyncio
+import tempfile
+
+from rattler import solve, install, VirtualPackage
+
+async def main() -> None:
+    # Start by solving the environment.
+    #
+    # Solving is the process of going from specifications of package and their
+    # version requirements to a list of concrete packages.
+    print("started solving the environment")
+    solved_records = await solve(
+        # Channels to use for solving
+        channels=["conda-forge"],
+        # The specs to solve for
+        specs=["python ~=3.12.0", "pip", "requests 2.31.0"],
+        # Virtual packages define the specifications of the environment
+        virtual_packages=VirtualPackage.detect(),
+    )
+    print("solved required dependencies")
+
+    # Install the packages into a new environment (or updates it if it already
+    # existed).
+    env_path = tempfile.mkdtemp()
+    await install(
+        records=solved_records,
+        target_prefix=env_path,
+    )
+
+    print(f"created environment: {env_path}")
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+</details>
+
+### Javascript
+
+To use the Javascript bindings, you can install the `@conda-org/rattler` package via npm. rattler is compiled to WebAssembly and can be used in the browser or in Node.js.
+
+```bash
+npm install @conda-org/rattler
+```
+
+Using rattler from Javascript is useful to get access to the same version comparison functions as used throughout the conda ecosystem. It is also used as part of [`mambajs`](https://github.com/emscripten-forge/mambajs) which uses the rattler library to solve and install packages from the emscripten-forge channel _in the browser_.
+
+
+## Give it a try!
+
+Before you begin, make sure you have the following prerequisites:
+- A recent version of [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
+- A recent version of [pixi](https://github.com/prefix-dev/pixi)
+
+Follow these steps to clone, compile, and run the rattler project:
+```shell
+# Clone the rattler repository along with its submodules:
+git clone --recursive https://github.com/conda/rattler.git
+cd rattler
+
+# Compile and execute rattler to create a JupyterLab instance:
+pixi run rattler create jupyterlab
+```
+
+The above command will execute the `rattler` executable in release mode.
+It will download and install an environment into the `.prefix` folder that contains [`jupyterlab`](https://jupyterlab.readthedocs.io/en/stable/getting_started/overview.html) and all the dependencies required to run it (like `python`)
+
+Run the following command to start jupyterlab:
+
+```shell
+# on windows
+.\.prefix\Scripts\jupyter-lab.exe
+
+# on linux or macOS
+ ./.prefix/bin/jupyter-lab
+```
+
+Voila!
+You have a working installation of jupyterlab installed on your system!
+You can of course install any package you want this way.
+Try it!
+
+## Contributing 😍
+
+We would love to have you contribute!
+See the CONTRIBUTION.md for more info. For questions, requests or a casual chat, we are very active on our discord server.
+You can [join our discord server via this link][chat-url].
+
+
+## Components
+
+Rattler consists of several crates that provide different functionalities.
+
+* **rattler_conda_types**: foundational types for all datastructures used within the conda eco-system.
+* **rattler_package_streaming**: provides functionality to download, extract and create conda package archives.
+* **rattler_repodata_gateway**: downloads, reads and processes information about existing conda packages from an index.
+* **rattler_shell**: code to activate an existing environment and run programs in it.
+* **rattler_solve**: a backend agnostic library to solve the package satisfiability problem.
+* **rattler_virtual_packages**: a crate to detect system capabilities.
+* **rattler_index**: create local conda channels from local packages.
+* **rattler**: functionality to create complete environments from scratch using the crates above.
+* **rattler-lock**: a library to create and parse lockfiles for conda environments.
+* **rattler-networking**: common functionality for networking, like authentication, mirroring and more.
+* **rattler-bin**: an example of a package manager using all the crates above (see: [showcase](#showcase))
+
+You can find these crates in the `crates` folder.
+
+Additionally, we provide Python bindings for most of the functionalities provided by the above crates.
+A python package `py-rattler` is available on [conda-forge](https://prefix.dev/channels/conda-forge/packages/py-rattler) and [PyPI](https://pypi.org/project/py-rattler/).
+Documentation for the python bindings can be found [here](https://conda.github.io/rattler/py-rattler).
+
+## What is conda & conda-forge?
+
+The conda ecosystem provides **cross-platform**, **binary** packages that you can use with **any programming language**.
+`conda` is an open-source package management system and environment management system that can install and manage multiple versions of software packages and their dependencies.
+`conda` is written in Python.
+The aim of Rattler is to provide all functionality required to work with the conda ecosystem from Rust.
+Rattler is not a reimplementation of `conda`.
+`conda` is a package management tool.
+Rattler is a _library_ to work with the conda ecosystem from different languages and applications.
+For example, it powers the backend of https://prefix.dev.
+
+`conda-forge` is a community-driven effort to bring new and existing software into the conda ecosystem.
+It provides _tens-of-thousands of up-to-date_ packages that are maintained by a community of contributors.
+For an overview of available packages see https://prefix.dev.