pagen 0.0.0

Parser generator.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

pagen
=====

[![](https://github.com/lycantropos/pagen/workflows/CI/badge.svg)](https://github.com/lycantropos/pagen/actions/workflows/ci.yml "Github Actions")
[![](https://codecov.io/gh/lycantropos/pagen/branch/master/graph/badge.svg)](https://codecov.io/gh/lycantropos/pagen "Codecov")
[![](https://img.shields.io/github/license/lycantropos/pagen.svg)](https://github.com/lycantropos/pagen/blob/master/LICENSE "License")
[![](https://badge.fury.io/py/pagen.svg)](https://badge.fury.io/py/pagen "PyPI")
[![](https://img.shields.io/crates/v/pagen.svg)](https://crates.io/crates/pagen "crates.io")

In what follows `python` is an alias for `python3.10` or `pypy3.10`
or any later version (`python3.11`, `pypy3.11` and so on).

Installation
------------

Install the latest `pip` & `setuptools` packages versions

```bash
python -m pip install --upgrade pip setuptools
```

### User

Download and install the latest stable version from `PyPI` repository

```bash
python -m pip install --upgrade pagen
```

### Developer

Download the latest version from `GitHub` repository

```bash
git clone https://github.com/lycantropos/pagen.git
cd pagen
```

Install

```bash
python setup.py install
```

Development
-----------

### Bumping version

#### Preparation

Install [bump-my-version](https://github.com/callowayproject/bump-my-version#installation).

#### Release

Choose which version number category to bump following [semver
specification](http://semver.org/).

Test bumping version

```bash
bump-my-version bump --dry-run --verbose $CATEGORY
```

where `$CATEGORY` is the target version number category name, possible
values are `patch`/`minor`/`major`.

Bump version

```bash
bump-my-version bump --verbose $CATEGORY
```

This will set version to `major.minor.patch`.

### Running tests

Install dependencies

```bash
python -m pip install -r requirements-tests.txt
```

Plain

```bash
pytest
```

Inside `Docker` container:

- with `CPython`
  ```bash
  docker-compose --file docker-compose.cpython.yml up
  ```
- with `PyPy`
  ```bash
  docker-compose --file docker-compose.pypy.yml up
  ```

`Bash` script:

- with `CPython`
  ```bash
  ./run-tests.sh
  ```
  or
  ```bash
  ./run-tests.sh cpython
  ```

- with `PyPy`
  ```bash
  ./run-tests.sh pypy
  ```

`PowerShell` script:

- with `CPython`
  ```powershell
  .\run-tests.ps1
  ```
  or
  ```powershell
  .\run-tests.ps1 cpython
  ```
- with `PyPy`
  ```powershell
  .\run-tests.ps1 pypy
  ```