Skip to content
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.

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

Change installed "binary" name to aca-py #40

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 DevReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,20 +31,20 @@ To put ACA-Py through its paces at the command line, checkout our [demos](docs/G

## Running

After installing the PyPi package, the executable `acagent` should be available in your PATH.
After installing the PyPi package, the executable `aca-py` should be available in your PATH.

Find out more about the available command line parameters by running:

```bash
acagent --help
aca-py --help
```

Currently you must specify at least one _inbound_ and one _outbound_ transport.

For example:

```bash
acagent --inbound-transport http 0.0.0.0 8000 \
aca-py --inbound-transport http 0.0.0.0 8000 \
--inbound-transport http 0.0.0.0 8001 \
--inbound-transport ws 0.0.0.0 8002 \
--outbound-transport ws \
Expand Down
11 changes: 11 additions & 0 deletions PUBLISHING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# How to Publish a New Version

0. The code to be published should be in the `master` branch.

1. Update the version number listed in [aries_cloudagent/version.py](aries_cloudagent/version.py). The incremented version number should adhere to the [Semantic Versioning Specification](https://semver.org/#semantic-versioning-specification-semver) based on the changes since the last published release.

2. Create a new GitHub release. The tag name and title of the release should be the same as the version in [aries_cloudagent/version.py](aries_cloudagent/version.py).

3. Create a new [distribution package](https://packaging.python.org/glossary/#term-distribution-package) with `python setup.py sdist bdist_wheel`.

4. Publish the release to [PyPI](https://pypi.org) using [twine](https://pypi.org/project/twine/) with `twine upload dist/*`.
File renamed without changes.
2 changes: 1 addition & 1 deletion demo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Note that Alice and Faber will each use 5 ports, e.g. if you run ```python faber

To create the Alice/Faber wallets using postgres storage, just add the "--postgres" option when running the script.

These scripts implement the controller and run the agent as a sub-process (see the documentation for `acagent`). The controller publishes a rest service to receive web hook callbacks from their agent.
These scripts implement the controller and run the agent as a sub-process (see the documentation for `aca-py`). The controller publishes a rest service to receive web hook callbacks from their agent.

Refer to the [Follow The Script](#follow-the-script) section below for further instructions.

Expand Down
2 changes: 1 addition & 1 deletion demo/agent.py
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ def _process(self, args, env, loop):
return proc

def get_process_args(self, bin_path: str = None):
cmd_path = "acagent"
cmd_path = "aca-py"
if bin_path is None:
bin_path = DEFAULT_BIN_PATH
if bin_path:
Expand Down
4 changes: 3 additions & 1 deletion docker/Dockerfile.run
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,14 @@ ENV ENABLE_PTVSD 0
ADD requirements.txt .
ADD requirements.dev.txt .


RUN pip3 install --no-cache-dir -r requirements.txt -r requirements.dev.txt

ADD aries_cloudagent ./aries_cloudagent
ADD bin ./bin
ADD README.md ./
ADD setup.py ./

RUN pip3 install --no-cache-dir -e .

ENTRYPOINT ["/bin/bash", "-c", "acagent \"$@\"", "--"]
ENTRYPOINT ["/bin/bash", "-c", "aca-py \"$@\"", "--"]
8 changes: 7 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
"""Module setup."""

import os
import runpy
from setuptools import setup, find_packages

PACKAGE_NAME = "aries_cloudagent"
version_meta = runpy.run_path("./{}/version.py".format(PACKAGE_NAME))
VERSION = version_meta["__version__"]

with open(os.path.abspath("./README.md"), "r") as fh:
long_description = fh.read()


def parse_requirements(filename):
"""Load requirements from a pip requirements file."""
Expand All @@ -18,9 +22,11 @@ def parse_requirements(filename):
setup(
name=PACKAGE_NAME,
version=VERSION,
long_description=long_description,
long_description_content_type="text/markdown",
packages=find_packages(),
include_package_data=True,
install_requires=parse_requirements("requirements.txt"),
python_requires=">=3.6.3",
scripts=["bin/acagent"],
scripts=["bin/aca-py"],
)