# 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
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
Metadata
Release files for LinkY 0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| LinkY-0.1.tar.gz | 3.0 kB | Details |
Release files / LinkY-0.1.tar.gz
| Download URL | LinkY-0.1.tar.gz |
|---|---|
| Size | 3.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4b5989312fbdb002031aa1a0cb7544835cc37dbcd82777b3621fd0a78500cac0
|
|
BLAKE2b-256 checksum How to use checksums |
c0a6ba2eb8b22ef96f6d4d400bd437a82ecb76ad8b9542c30686cbf4dfbb0937
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |