Metadata-Version: 2.4
Name: dotslash
Version: 0.5.8
Summary: Command-line tool to facilitate fetching an executable, caching it, and then running it.
Project-URL: Homepage, https://dotslash-cli.com
Project-URL: Tracker, https://github.com/facebook/dotslash/issues
Project-URL: Source, https://github.com/facebook/dotslash
Author-email: Ofek Lev <oss@ofek.dev>
License-Expression: MIT OR Apache-2.0
Keywords: dotslash
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.10
Description-Content-Type: text/markdown

# DotSlash: simplified executable deployment

[![CI - Build](https://github.com/ofek/dotslash/actions/workflows/build.yml/badge.svg)](https://github.com/ofek/dotslash/actions/workflows/build.yml)
[![CI - Test](https://github.com/ofek/dotslash/actions/workflows/test.yml/badge.svg)](https://github.com/ofek/dotslash/actions/workflows/test.yml)
[![PyPI - Version](https://img.shields.io/pypi/v/dotslash.svg?logo=pypi&label=PyPI&logoColor=gold)](https://pypi.org/project/dotslash/)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/dotslash.svg?color=blue&label=Downloads&logo=pypi&logoColor=gold)](https://pypi.org/project/dotslash/)
[![Built by Hatch](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch)
[![Ruff linting/formatting](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

-----

[DotSlash](https://dotslash-cli.com/docs/) (`dotslash`) is a command-line tool that lets you represent a set of platform-specific, heavyweight executables with an equivalent small, easy-to-read text file. In turn, this makes it efficient to store executables in source control without hurting repository size. This paves the way for checking build toolchains and other tools directly into the repo, reducing dependencies on the host environment and thereby facilitating reproducible builds.

The `dotslash` package allows you to use DotSlash in your Python projects without having to install DotSlash globally.

***Table of Contents***

- [Using as a library](#using-as-a-library)
- [Using as a command-line tool](#using-as-a-command-line-tool)
- [License](#license)

## Using as a library

The `dotslash.locate` function returns the path to the DotSlash binary that was installed by this package.

```pycon
>>> import dotslash
>>> dotslash.locate()
'/root/.local/bin/dotslash'
```

## Using as a command-line tool

The installed DotSlash binary can be invoked directly by running the `dotslash` module as a script.

```
python -m dotslash path/to/dotslash-file.json
```

## License

DotSlash is licensed under both the MIT license and Apache-2.0 license; the exact terms can be found in the [LICENSE-MIT]() and LICENSE-APACHE files, respectively.
