-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
26 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,20 @@ | ||
# ViUR-cli | ||
|
||
Command-line interface for ViUR application development maintenance. | ||
<div align="center"> | ||
<img src="https://github.com/viur-framework/viur-artwork/raw/main/icons/icon-cli.svg" height="196" alt="A hexagonal logo of the viur-cli" title="viur-cli"> | ||
<h1>viur-cli</h1> | ||
<a href="https://pypi.org/project/viur-cli/"> | ||
<img alt="Badge showing current PyPI version" title="PyPI" src="https://img.shields.io/pypi/v/viur-cli"> | ||
</a> | ||
<a href="https://opensource.org/licenses/MIT"> | ||
<img src="https://img.shields.io/pypi/l/viur-cli" alt="Badge displaying the license" title="License badge"> | ||
</a> | ||
<br> | ||
Command-line interface for <a href="https://www.viur.dev">ViUR framework</a> project maintenance. | ||
</div> | ||
|
||
## Usage | ||
|
||
viur-cli allows for control, maintain and develop a ViUR project from one central location by using the `viur` command | ||
`viur-cli` allows to control, maintain and develop a ViUR project from one central location by using the `viur` command. | ||
|
||
```sh | ||
$ viur --help | ||
$ viur init | ||
|
@@ -19,15 +29,16 @@ $ viur env | |
|
||
## Installation | ||
|
||
To use viur-cli in your ViUR projects, use [pipenv](https://pypi.org/project/pipenv/). | ||
To use `viur-cli` in your ViUR projects, install the [PyPI package `viur-cli`](https://pypi.org/project/pipenv/). | ||
|
||
```bash | ||
$ pipenv install --dev viur-cli | ||
``` | ||
|
||
## Packaged scripts | ||
|
||
In order to use some of the packaged scripts, it is possible to simply run them from the environment that you installed viur-cli into. So if you are using a pipenv, then the scripts will be available in the shell just like you would run viur-cli by calling viur as well. | ||
In order to use the packaged scripts, it is possible to simply run them from the environment that you installed viur-cli into. | ||
So if you are using a pipenv, then the scripts will be available in the shell just like you would run viur-cli by calling viur as well. | ||
|
||
A handy script that has to be started this way is viur-2to3, which will automatically crawl through a project folder and detect deprecated syntax. | ||
It is not only useful for porting viur2 projects to viur3, but also when there are deprecations or breaking changes in viur3! | ||
|
@@ -41,7 +52,7 @@ This will dry-run the script in the current directory and not make any changes, | |
|
||
## Development | ||
|
||
If you want to hack viur-cli, clone viur-cli next to your viur project folder. | ||
If you want to hack `viur-cli`, clone this repository next to the folder of your ViUR project. | ||
|
||
```sh | ||
$ git clone [email protected]:viur-framework/viur-cli.git | ||
|
@@ -50,7 +61,7 @@ viur-cli | |
your-project | ||
``` | ||
|
||
Then, add it to your project this way | ||
Then, add it to your project as an editable dependency using | ||
|
||
```sh | ||
$ cd your-project | ||
|
@@ -69,4 +80,8 @@ viur-cli depends on | |
|
||
## License | ||
|
||
Distributed under the MIT License. See `LICENSE` for more information. | ||
Copyright © 2023 by Mausbrand Informationssysteme GmbH.<br> | ||
Mausbrand and ViUR are registered trademarks of Mausbrand Informationssysteme GmbH. | ||
|
||
This project is free software under the MIT license.<br> | ||
Please see the LICENSE file for details. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters