Skip to content

Commit d05a4db

Browse files
committed
Re-migrate with script only
1 parent 09b0682 commit d05a4db

132 files changed

Lines changed: 1776 additions & 1652 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.copier-answers.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ project_description: Signatures for entire Python programs. Extract the structur
1212
the frame, the skeleton of your project, to generate API documentation or find
1313
breaking changes in your API.
1414
project_name: Griffe
15-
python_package_command_line_name: griffe
16-
python_package_distribution_name: griffe
17-
python_package_import_name: griffe
18-
repository_name: griffe
15+
python_package_command_line_name: griffelib
16+
python_package_distribution_name: griffelib
17+
python_package_import_name: griffelib
18+
repository_name: griffelib
1919
repository_namespace: mkdocstrings
2020
repository_provider: github.com
2121

.github/ISSUE_TEMPLATE/1-bug.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ PASTE TRACEBACK HERE
5050
redacting sensitive information. -->
5151

5252
```bash
53-
griffe --debug-info # | xclip -selection clipboard
53+
griffelib --debug-info # | xclip -selection clipboard
5454
```
5555

5656
PASTE MARKDOWN OUTPUT HERE

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -869,7 +869,7 @@ We are still in v0, so no major bump yet.
869869

870870
### Bug Fixes
871871

872-
- Use already parsed docstring sections when dumping full data ([311807b](https://github.com/mkdocstrings/griffe/commit/311807b8fa1716dabe5ba18d3e12c947286afd8e) by Timothée Mazzucotelli). [Discussion griffe-typingdoc#6](https://github.com/mkdocstrings/griffe-typingdoc/discussions/6)
872+
- Use already parsed docstring sections when dumping full data ([311807b](https://github.com/mkdocstrings/griffe/commit/311807b8fa1716dabe5ba18d3e12c947286afd8e) by Timothée Mazzucotelli). [Discussion griffelib-typingdoc#6](https://github.com/mkdocstrings/griffe-typingdoc/discussions/6)
873873

874874
## [0.36.7](https://github.com/mkdocstrings/griffe/releases/tag/0.36.7) - 2023-10-17
875875

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
Signatures for entire Python programs. Extract the structure, the frame, the skeleton of your project, to generate API documentation or find breaking changes in your API.
1212

1313
Griffe, pronounced "grif" (`/ɡʁif/`), is a french word that means "claw",
14-
but also "signature" in a familiar way. "On reconnaît bien là sa griffe."
14+
but also "signature" in a familiar way. "On reconnaît bien là sa griffelib."
1515

1616
- [User guide](https://mkdocstrings.github.io/griffe/guide/users/)
1717
- [Contributor guide](https://mkdocstrings.github.io/griffe/guide/contributors/)
@@ -20,13 +20,13 @@ but also "signature" in a familiar way. "On reconnaît bien là sa griffe."
2020
## Installation
2121

2222
```bash
23-
pip install griffe
23+
pip install griffelib
2424
```
2525

2626
With [`uv`](https://docs.astral.sh/uv/):
2727

2828
```bash
29-
uv tool install griffe
29+
uv tool install griffelib
3030
```
3131

3232
## Usage
@@ -36,7 +36,7 @@ uv tool install griffe
3636
**On the command line**, pass the names of packages to the `griffe dump` command:
3737

3838
```console
39-
$ griffe dump httpx fastapi
39+
$ griffelib dump httpx fastapi
4040
{
4141
"httpx": {
4242
"name": "httpx",
@@ -56,7 +56,7 @@ See the [Serializing chapter](https://mkdocstrings.github.io/griffe/guide/users/
5656
Pass a relative path to the `griffe check` command:
5757

5858
```console
59-
$ griffe check mypackage --verbose
59+
$ griffelib check mypackage --verbose
6060
mypackage/mymodule.py:10: MyClass.mymethod(myparam):
6161
Parameter kind was changed:
6262
Old: positional or keyword
@@ -66,7 +66,7 @@ Parameter kind was changed:
6666
For `src` layouts:
6767

6868
```console
69-
$ griffe check --search src mypackage --verbose
69+
$ griffelib check --search src mypackage --verbose
7070
src/mypackage/mymodule.py:10: MyClass.mymethod(myparam):
7171
Parameter kind was changed:
7272
Old: positional or keyword
@@ -78,13 +78,13 @@ It's also possible to directly **check packages from PyPI.org**
7878
This feature requires that you install Griffe with the `pypi` extra:
7979

8080
```bash
81-
pip install griffe[pypi]
81+
pip install griffelib[pypi]
8282
```
8383

8484
The command syntax is:
8585

8686
```bash
87-
griffe check package_name -b project-name==2.0 -a project-name==1.0
87+
griffelib check package_name -b project-name==2.0 -a project-name==1.0
8888
```
8989

9090
See the [Checking chapter](https://mkdocstrings.github.io/griffe/guide/users/checking/) for more examples.
@@ -94,20 +94,20 @@ See the [Checking chapter](https://mkdocstrings.github.io/griffe/guide/users/che
9494
**With Python**, loading a package:
9595

9696
```python
97-
import griffe
97+
import griffelib
9898

99-
fastapi = griffe.load("fastapi")
99+
fastapi = griffelib.load("fastapi")
100100
```
101101

102102
Finding breaking changes:
103103

104104
```python
105-
import griffe
105+
import griffelib
106106

107-
previous = griffe.load_git("mypackage", ref="0.2.0")
108-
current = griffe.load("mypackage")
107+
previous = griffelib.load_git("mypackage", ref="0.2.0")
108+
current = griffelib.load("mypackage")
109109

110-
for breakage in griffe.find_breaking_changes(previous, current):
110+
for breakage in griffelib.find_breaking_changes(previous, current):
111111
...
112112
```
113113

config/coverage.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
branch = true
33
parallel = true
44
source =
5-
src/griffe
5+
packages/griffe/src/griffe
66
tests/
77

88
[coverage:paths]

config/ruff.toml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,24 +38,24 @@ ignore = [
3838
logger-objects = ["griffe.logger"]
3939

4040
[lint.per-file-ignores]
41-
"src/griffe/__main__.py" = [
41+
"packages/griffe/src/griffe/__main__.py" = [
4242
"D100", # Missing module docstring
4343
]
44-
"src/griffe/_internal/cli.py" = [
44+
"packages/griffe/src/griffe/_internal/cli.py" = [
4545
"T201", # Print statement
4646
]
47-
"src/griffe/_internal/git.py" = [
47+
"packages/griffe/src/griffe/_internal/git.py" = [
4848
"S603", # `subprocess` call: check for execution of untrusted input
4949
"S607", # Starting a process with a partial executable path
5050
]
51-
"src/griffe/_internal/agents/nodes/*.py" = [
51+
"packages/griffe/src/griffe/_internal/agents/nodes/*.py" = [
5252
"ARG001", # Unused function argument
5353
"N812", # Lowercase `keyword` imported as non-lowercase `NodeKeyword`
5454
]
55-
"src/griffe/_internal/debug.py" = [
55+
"packages/griffe/src/griffe/_internal/debug.py" = [
5656
"T201", # Print statement
5757
]
58-
"src/griffe/_internal/**.py" = [
58+
"packages/griffe/src/griffe/_internal/**.py" = [
5959
"D100", # Missing docstring in public module
6060
]
6161
"scripts/*.py" = [

docs/extensions/built-in/dataclasses.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,14 @@ Additional metadata like `ClassVar`, the `init` and `kw_only` parameters, or the
2929

3030
=== "CLI"
3131
```console
32-
$ griffe dump -e dataclasses,other my_package
32+
$ griffelib dump -e dataclasses,other my_package
3333
```
3434

3535
=== "Python"
3636
```python
37-
import griffe
37+
import griffelib
3838

39-
my_package = griffe.load("my_package", extensions=griffe.load_extensions("dataclasses", "other"))
39+
my_package = griffelib.load("my_package", extensions=griffe.load_extensions("dataclasses", "other"))
4040
```
4141

4242
=== "mkdocstrings"

docs/extensions/built-in/unpack-typeddict.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,14 +65,14 @@ To enable the extension:
6565

6666
=== "CLI"
6767
```console
68-
$ griffe dump -e unpack_typeddict my_package
68+
$ griffelib dump -e unpack_typeddict my_package
6969
```
7070

7171
=== "Python"
7272
```python
73-
import griffe
73+
import griffelib
7474

75-
my_package = griffe.load("my_package", extensions=griffe.load_extensions("unpack_typeddict"))
75+
my_package = griffelib.load("my_package", extensions=griffe.load_extensions("unpack_typeddict"))
7676
```
7777

7878
=== "mkdocstrings"

docs/extensions/official/runtime-objects.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010
This extension stores runtime objects corresponding to each loaded Griffe object into its `extra` attribute, under the `runtime-objects` namespace.
1111

1212
```pycon
13-
>>> import griffe
14-
>>> griffe_data = griffe.load("griffe", extensions=griffe.load_extensions("griffe_runtime_objects"), resolve_aliases=True)
13+
>>> import griffelib
14+
>>> griffe_data = griffelib.load("griffe", extensions=griffe.load_extensions("griffe_runtime_objects"), resolve_aliases=True)
1515
>>> griffe_data["parse"].extra
1616
defaultdict(<class 'dict'>, {'runtime-objects': {'object': <function parse at 0x78685c951260>}})
1717
>>> griffe_data["Module"].extra

docs/guide/contributors/architecture.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ descriptions = {
2222
"scripts": "Our different scripts. See [Scripts, configuration](#scripts-configuration).",
2323
"site": "Documentation site, built with `make run mkdocs build` (git-ignored).",
2424
"src": "The source of our Python package(s). See [Sources](#sources) and [Program structure](#program-structure).",
25-
"src/griffe": "Our public API, exposed to users. See [Program structure](#program-structure).",
26-
"src/griffe/_internal": "Our internal API, hidden from users. See [Program structure](#program-structure).",
25+
"packages/griffe/src/griffe": "Our public API, exposed to users. See [Program structure](#program-structure).",
26+
"packages/griffe/src/griffe/_internal": "Our internal API, hidden from users. See [Program structure](#program-structure).",
2727
"tests": "Our test suite. See [Tests](#tests).",
2828
".copier-answers.yml": "The answers file generated by [Copier](https://copier.readthedocs.io/en/stable/). See [Boilerplate](#boilerplate).",
2929
"devdeps.txt": "Our development dependencies specification. See [`make setup`][command-setup] command.",
@@ -108,7 +108,7 @@ The test suite is based on [pytest](https://docs.pytest.org/en/8.2.x/). Test mod
108108

109109
## Program structure
110110

111-
The internal API is contained within the `src/griffe/_internal` folder. The top-level `griffe/__init__.py` module exposes all the public API, by importing the internal objects from various submodules of `griffe._internal`.
111+
The internal API is contained within the `packages/griffe/src/griffe/_internal` folder. The top-level `griffe/__init__.py` module exposes all the public API, by importing the internal objects from various submodules of `griffe._internal`.
112112

113113
Users then import `griffe` directly, or import objects from it.
114114

@@ -122,7 +122,7 @@ if os.getenv("DEPLOY") == "true":
122122
from pydeps.target import Target
123123

124124
cli.verbose = cli._not_verbose
125-
options = cli.parse_args(["src/griffe", "--noshow", "--reverse"])
125+
options = cli.parse_args(["packages/griffe/src/griffe", "--noshow", "--reverse"])
126126
colors.START_COLOR = 128
127127
target = Target(options["fname"])
128128
with target.chdir_work():

0 commit comments

Comments
 (0)