Skip to content

Commit

Permalink
Merge branch 'chore/kolasu-alignment'
Browse files Browse the repository at this point in the history
  • Loading branch information
alessiostalla committed Sep 6, 2023
2 parents 22f1678 + 7554495 commit 09fa127
Show file tree
Hide file tree
Showing 10 changed files with 49 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/pythonapp.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ jobs:
build:
strategy:
matrix:
python: [ '3.7', '3.8', '3.9', '3.10' ]
python: [ '3.7', '3.8', '3.9', '3.10', '3.11' ]
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ pyvenv.cfg
__pycache__
/.token
/antlr-*.jar
.DS_Store
5 changes: 5 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@
# Required
version: 2

build:
os: ubuntu-22.04
tools:
python: "3.11"

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py
20 changes: 20 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Changelog
All notable changes to this project from version 0.4.0 upwards are documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

## [0.5.0] – 2023-09-06

### Added
- AST transformers, aligned with the latest Kolasu 1.5.x version
- `assert_asts_are_equal` function to support writing assertions in a test suite
- documentation generation (published on https://pylasu.readthedocs.io)
- export more symbols

### Changed
- Alignment with Kolasu:
- `PropertyDescriptor` renamed to `PropertyDescription`
- `Node.properties` generates `PropertyDescription` instances rather than tuples

### Fixed
- `PossiblyNamed` implementation
- `Concept.node_properties`
1 change: 1 addition & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
prune tests
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,18 @@ flake8 . && flake8 tests

## Packaging and distributing

Update version in pyproject.toml, setup.cfg and setup.py _(TODO do we need all three?)_, then run:
Update version in `pyproject.toml`, `setup.cfg` and `pylasu/__version__.py` _(TODO do we need all three?)_,
commit and check that CI completes normally. Then run:

```shell
rm dist/*
python -m build
python -m twine upload dist/*
```

**Note:** if we have [two-factor authentication (2FA)](https://pypi.org/help/#twofa) enabled on PyPI,
we have to [use an API token](https://pypi.org/help/#apitoken).

If all goes well, tag the release:

```shell
Expand Down Expand Up @@ -57,4 +61,5 @@ make html
If everything goes as it should, in `docs/_build/html` you'll find the generated documentation.

We also host the documentation on ReadTheDocs. The project is [pylasu](https://readthedocs.org/projects/pylasu/).
Documentation needs to be built manually for each release for it to appear online on https://pylasu.readthedocs.io.
Documentation needs to be [built manually](https://readthedocs.org/projects/pylasu/) for each release for it to appear
online on https://pylasu.readthedocs.io.
1 change: 1 addition & 0 deletions pylasu/__version__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
__version__ = "0.5.0"
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "pylasu"
version = "0.4.0"
version = "0.5.0"
authors = [
{ name="Lorenzo Addazi", email="[email protected]" },
{ name="Alessio Stalla", email="[email protected]" },
Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[metadata]
name = Pylasu
version: 0.4.0
version: 0.5.0

[coverage:run]
branch = True
Expand Down
12 changes: 11 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,18 @@
import os

from setuptools import find_packages, setup

here = os.path.abspath(os.path.dirname(__file__))

# Load the package's __version__.py module as a dictionary.
about = {}
with open(os.path.join(here, "pylasu", '__version__.py')) as f:
exec(f.read(), about)

setup(
name='pylasu',
packages=find_packages(exclude=["tests"]),
version='0.4.0',
version=about['__version__'],
description='Pylasu is an AST Library in the StarLasu family, targeting the Python language.',
author='Strumenta S.R.L.',
license='Apache License V2',
Expand Down

0 comments on commit 09fa127

Please sign in to comment.