Skip to content

Commit

Permalink
typo in README, add gitignore back, fix testbundle README
Browse files Browse the repository at this point in the history
* typo in README, add gitignore back, fix testbundle README
  • Loading branch information
splashx authored Nov 12, 2017
1 parent 6906c99 commit 170e244
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 23 deletions.
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
**/*.pyc
**/*.pyo
build
dist
*.egg-info
.idea
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,11 @@ For example, defining:
* `commands\commanda.py` - maps to `!commanda`
* `commands\level1\commandb.py` - maps to `!level1-commandb`
* `commands\level1\level2a\commandc.py` - maps to `!level1-level2a-commandb`
* `commands\level1\level2b\leveln\commandz.py` - maps to `!level1-level2b-lebeln-commandz`
* `commands\level1\level2b\leveln\commandz.py` - maps to `!level1-level2b-leveln-commandz`


```
<bundle_name>
<bundle_directory>
|
|-- <bundle_name>
|-- __init__.py
Expand Down
34 changes: 13 additions & 21 deletions tests/testbundle/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,36 +3,28 @@ testbundle

# Overview

This is a dummy cog bundle used to test pycog3 python module
This is a dummy cog bundle used to test pycog3 python module.

# Installing

Create a virtual env and:

```bash
pip3 install --upgrade .
```


# Configuring

There is one dynamic configuration file which should be set in the environmental variables:

```bash
export dyn_config_var1

```
There is one dynamic configuration variable `dyn_config_var1` which should be set in the environmental variables:

# Executing

Should be executed after `pycog3` is installed.
If running outside cog's environment, at the root of the project `/`, do:

```bash
/usb/bin/cog-command
$ export PYTHONPATH=tests/testbundle
$ export COG_BUNDLE="testbundle"
$ export COG_COMMAND="commanda"
$ export dyn_config_var1="foo"
$ cog-command
COG_TEMPLATE: template
JSON
"0a"
```

# Building

To build the Docker image, simply run:

$ make docker

Requires Python 3.6.x, pip, make, and Docker.

0 comments on commit 170e244

Please sign in to comment.