Skip to content

Commit

Permalink
README improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
markgacoka committed Jun 10, 2024
1 parent ac94362 commit fef74e0
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 10 deletions.
13 changes: 4 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,14 @@ python main.py
## Testing
Run all tests
```
pytest tests
pytest codepropertygraph/tests
```

## Updating Library

1. Change the version number
1. Upgrade the version number in `codepropertygraph/setup.py`
```
--> VERSION="0.0.9"
DESCRIPTION="A Python implementation of a Code Property Graph."
LONG_DESCRIPTION="A tool for ..."
setup(
name='codepropertygraph',
version=VERSION,
--> VERSION="x.x.x"
```

2. Upload to Pypi
Expand All @@ -39,5 +33,6 @@ python setup.py sdist bdist_wheel
twine upload dist/*
```

If API token is requested, go to `.env` as `PYPI_API_TOKEN`.

For first time contributors, read the [CONTRIBUTING](https://github.com/markgacoka/codepropertygraph/blob/main/CONTRIBUTING.md) page.
2 changes: 1 addition & 1 deletion codepropertygraph/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ def read_file(filename):
with open(os.path.join(os.path.dirname(__file__), filename)) as file:
return file.read()

VERSION = "0.1.1"
VERSION = "0.1.2"
DESCRIPTION = "A Python implementation of a Code Property Graph."
LONG_DESCRIPTION = read_file('README.md')

Expand Down

0 comments on commit fef74e0

Please sign in to comment.