Skip to main content

Creates globally installed symlinks to test command line tools.

Project description

# LinkY

LinkY allows people creating command line interfaces to test their commands and packages
easily. The program creates globally installed symlinks for specified packages and
commands so that you can test your package structures, specify your commands, and run tests.

### configuration
Consider a sample directory structure:

proj/
|__ main_package/
| |__ index.py
| |__ ...
|
|__ setup.py
|__ README.md
|__ LICENSE.md

To configure LinkY, we add a `linky.json` file in the project's root directory:

proj/
|__ main_package/
| |__ index.py
| |__ ...
|
|__ setup.py
|__ README.md
|__ LICENSE.md
|__ linky.json

Then, we can write in the configurations:

linky.json

{
"name": "main_package",
"bin": {
"any_command" : "index.py"
}
}

LinkY will identify the main package and retrieve the specified entry point file.

### usage
`$ linky link` or `$linky -l` wires up an executable file and globally installs your package. In our example, running
`$ any_command` will run the specified entry point file.

`$ linky unlink` or `$ linky -u` uninstalls the your package and disables the specified command.

### notes
- unlinking does not delete your package or files
- `linky.json` will be overwritten to save package and command locations, but the data you entered will remain intact

Project details


Release history Release notifications | RSS feed

This version

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

LinkY-0.1.tar.gz (3.0 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page