Skip to content

Remove prompts from copyable docs commands #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Mirochill wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Remove prompts from copyable docs commands #52

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,8 +133,8 @@
changes slightly the report that was produced. [#16][16]

```
$ chaos report --export-format=pdf journal1.json journal2.json report.pdf
$ chaos report --export-format=pdf journal*.json report.pdf
chaos report --export-format=pdf journal1.json journal2.json report.pdf
chaos report --export-format=pdf journal*.json report.pdf
```

[16]: https://github.com/chaostoolkit/chaostoolkit-reporting/issues/16
Expand Down Expand Up @@ -270,4 +270,4 @@

### Added

- Initial release
- Initial release
24 changes: 12 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ PDF or HTML document.
Install this package as any other Python packages:

```console
$ pip install -U chaostoolkit-reporting
pip install -U chaostoolkit-reporting
```

Notice that this draws a few [dependencies][deps]:
Expand All @@ -40,25 +40,25 @@ Once installed, a new `report` subcommand will be made available to the
`chaos` command, use it as follows:

```console
$ chaos report --export-format=html5 journal.json report.html
chaos report --export-format=html5 journal.json report.html
```

or, for a PDF document:

```console
$ chaos report --export-format=pdf journal.json report.pdf
chaos report --export-format=pdf journal.json report.pdf
```

You can also generate a single report from many journals at once:

```console
$ chaos report --export-format=pdf journal-1.json journal-2 journal-3 report.pdf
chaos report --export-format=pdf journal-1.json journal-2 journal-3 report.pdf
```

Or more succinctly:

```console
$ chaos report --export-format=pdf journal-*.json report.pdf
chaos report --export-format=pdf journal-*.json report.pdf
```

## Download a Docker Image
Expand All @@ -70,7 +70,7 @@ pull. You can install `Docker` from the [Docker Hub][dockerhub].
[dockerhub]: https://hub.docker.com/search?q=&type=edition&offering=community

```console
$ docker pull chaostoolkit/reporting
docker pull chaostoolkit/reporting
```

### Use a Docker container
Expand All @@ -80,7 +80,7 @@ file, generated during an experiment run, can be found. To check for this you ca


```console
$ ls
ls
```

And you should see the `journal.json` file:
Expand All @@ -92,7 +92,7 @@ journal.json
Now you can run the docker command:

```console
$ docker run \
docker run \
--user `id -u` \
-v `pwd`:/tmp/result \
-it \
Expand All @@ -102,7 +102,7 @@ $ docker run \
This will create `chaostoolkit.log` and `report.pdf` files in this directory.

```console
$ ls
ls
```

```
Expand All @@ -120,14 +120,14 @@ The default command of the image is equivalent to running this without a
container:

```console
$ chaos report --export-format=pdf journal.json report.pdf
chaos report --export-format=pdf journal.json report.pdf
```

If you wish to override that command, pass the `chaos report` parameters as
follows:

```console
$ docker run \
docker run \
--user `id -u` \
-v `pwd`:/tmp/result \
-it \
Expand All @@ -138,7 +138,7 @@ $ docker run \
And the same files will be created:

```console
$ ls
ls
```

```
Expand Down
8 changes: 4 additions & 4 deletions uni-install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,20 @@ That's enough to produce HTML reports, but if you'd like to produce `.pdf` repor
The best way to install `latex` is to use Homebrew to grab `basictex`:

```
$ brew install basictex
brew install basictex
```

Then use `ls /usr/local/Caskroom/basictex/` to see the actual directory the package resides in. Finally use the `open` command to run that Mac OS X package installer, for example:

```
$ open /usr/local/Caskroom/basictex/2017.0607/mactex-basictex-20170607.pkg
open /usr/local/Caskroom/basictex/2017.0607/mactex-basictex-20170607.pkg
```

### For Debian/Ubuntu
We recommend using `sudo` to install the following packages:

```
$ sudo apt-get install texlive-latex-base \
sudo apt-get install texlive-latex-base \
texlive-fonts-recommended \
texlive-fonts-extra \
texlive-latex-extra \
Expand All @@ -50,4 +50,4 @@ Once the installer has completed, you should then be able to produce `.pdf` repo

```RuntimeError: Python is not installed as a framework. The Mac OS X backend will not be able to function correctly if Python is not installed as a framework.```

In this case, run the following: `$ echo "backend: TkAgg" >> ~/.matplotlib/matplotlibrc`
In this case, run the following: `echo "backend: TkAgg" >> ~/.matplotlib/matplotlibrc`