Skip to content

Commit

Permalink
Refresh docs + media for PyPi release
Browse files Browse the repository at this point in the history
The Readme gets to the point faster, the images have
absolute URLs so they display properly on PyPi, library
versions have been set in setup.py for safety.
  • Loading branch information
Kaushik Ghose committed Oct 28, 2019
1 parent 5c3c3ea commit dafeb34
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 38 deletions.
82 changes: 47 additions & 35 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,11 @@
# Benten

This is a [language server] for [Common Workflow Language](https://www.commonwl.org/) documents.

<img align="right" height="150px" src="https://github.com/rabix/benten/blob/master/media/benten-icon.png"></img>
Many advanced CWL users are comfortable creating tools and workflows "by
hand" using a plain text editor. When creating complex enough workflows,
navigating and editing the resultant document and sub-documents can get
tedious. Keeping track of the bigger picture (what components have been
added, what connections have been set) can also get hard.

_Benten_ is a language server that offers help with code completion,
navigation and syntax checking of CWL documents.

_Benten_ is written using Python3 and developed against VS Code. The language
server component will work with any editor/IDE that offers language server
support. Syntax highlighting is currently only available for the VS Code
extension. The VS Code extension is written in Typescript.
This is a [language server] for
[Common Workflow Language](https://www.commonwl.org/) documents.

[language server]: https://langserver.org/

[![Tests](https://travis-ci.com/rabix/benten.svg?branch=master)](https://travis-ci.com/rabix/benten)
[![codecov](https://codecov.io/gh/rabix/benten/branch/master/graph/badge.svg)](https://codecov.io/gh/rabix/benten)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/20839ce29ebe4004b3578d4d02031a1c)](https://www.codacy.com/app/kaushik-work/benten?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=rabix/benten&amp;utm_campaign=Badge_Grade)

<img height="400px" src="https://github.com/rabix/benten/blob/master/media/2019.10.22/full-window.png"></img>

# Features
## Features

[(Click for feature screenshot gallery)](https://github.com/rabix/benten/blob/master/docs/features.md)

Expand All @@ -38,6 +18,17 @@ extension. The VS Code extension is written in Typescript.
- Type validations
- Port validations

![Benten Screenshot](https://raw.githubusercontent.com/rabix/benten/master/media/2019.10.22/full-window.png)

[![Tests](https://travis-ci.com/rabix/benten.svg?branch=master)](https://travis-ci.com/rabix/benten)
[![codecov](https://codecov.io/gh/rabix/benten/branch/master/graph/badge.svg)](https://codecov.io/gh/rabix/benten)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/20839ce29ebe4004b3578d4d02031a1c)](https://www.codacy.com/app/kaushik-work/benten?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=rabix/benten&amp;utm_campaign=Badge_Grade)
[![PyPI version](https://badge.fury.io/py/benten.svg)](https://badge.fury.io/py/benten)

_Benten_ is written using Python3 and developed against VS Code. The language
server component will work with any editor/IDE that offers language server
support. Syntax highlighting is currently only available for the VS Code
extension. The VS Code extension is written in Typescript.

# Server installation

Expand All @@ -46,11 +37,6 @@ Benten requires [Python 3.7 or later](https://www.python.org/downloads/)
If you will be installing from source you will need
[git](https://git-scm.com/downloads) on your system

## Special instructions for Ubuntu Linux

```
sudo apt install python3-pip python3-venv
```

## Using pipx

Expand All @@ -61,14 +47,39 @@ to use `pipx`
```
pip3 install pipx # in case you don't have pipx
pipx ensurepath # ensures CLI application directory is on your $PATH
pipx install --spec git+https://github.com/rabix/benten.git benten
pipx install benten
```

_Note: `pipx` installs the executables in `$HOME/.local/bin`
(`%HOMEPATH%\.local\bin` for Windows). This needs to be added to your
PATH env variable. `pipx ensurepath` does this for you_
Notes:

1. `pipx` installs the executables in `$HOME/.local/bin`
(`%HOMEPATH%\.local\bin` for Windows). This needs to be added to your
PATH env variable. `pipx ensurepath` does this for you
2. `pipx install` can be done from within another virtual environment.
This is helpful when you have an incompatible global version of
Python which you wish to keep but still want to install Benten. You
can create a virtual env with Python > 3.7 and invoke the
installation commands from there.


## Installing experimental versions
### Special instructions for Ubuntu Linux

```
sudo apt install python3-pip python3-venv
```

### Note for Windows
If you are trying to reinstall or updating the server on windows with
the server running (e.g. because you have VS Code running), you will
have to shutdown the server (e.g. by exiting VS Code) before updating.


### Installing versions directly from github

To install from the master branch
```
pipx install --spec git+https://github.com/rabix/benten.git benten
```

To install from develop branch (or some other branch):
```
Expand All @@ -85,8 +96,9 @@ pipx install -e benten

# Install VS Code extension

Search for "Benten" in the marketplace. The name of the client extension
is Rabix/benten. Follow the usual method to install the extension.
Search for "[Benten](https://marketplace.visualstudio.com/items?itemName=sbg-rabix.benten-cwl)" in the marketplace. The name of the client
extension is Rabix/benten. Follow the usual method to install the
extension.

# Using with VI/Vim

Expand Down
2 changes: 1 addition & 1 deletion benten/version.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Copyright (c) 2019 Seven Bridges. See LICENSE

__version__ = "2019.10.25"
__version__ = "2019.10.28"
5 changes: 3 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@
platforms=['POSIX', 'MacOS', 'Windows'],
python_requires='>=3.7.0',
install_requires=[
"ruamel.yaml",
"dukpy"
"ruamel.yaml >= 0.15.77",
"dukpy >= 0.2.2"
],
entry_points={
'console_scripts': [
Expand All @@ -36,6 +36,7 @@
maintainer_email='[email protected]',
author_email='[email protected]',
description='CWL language server developed by Seven Bridges',
url='https://github.com/rabix/benten',
long_description=long_description,
long_description_content_type="text/markdown",
include_package_data=True,
Expand Down

0 comments on commit dafeb34

Please sign in to comment.