@cspell/dict-python 4.2.18 → 4.2.19

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +73 -24
  3. package/package.json +3 -3
package/LICENSE CHANGED
@@ -1,6 +1,6 @@
1
1
  The MIT License (MIT)
2
2
 
3
- Copyright (c) 2017-2020 Jason Dent <jason@streetsidesoftware.nl>
3
+ Copyright (c) 2017-2025 Street Side Software <support@streetsidesoftware.nl>
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
package/README.md CHANGED
@@ -4,54 +4,103 @@ Python dictionary for cspell.
4
4
 
5
5
  This is a pre-built dictionary for use with cspell.
6
6
 
7
+ <!--- @@inject: ../../static/requirements.md --->
8
+
7
9
  ## Requirements
8
10
 
9
11
  | Tool | Version |
10
12
  | ------------------------------------------------------------------------------------------------------------------------------------ | ------- |
11
- | [cspell](https://github.com/streetsidesoftware/cspell) | `>= 6` |
12
- | [Code Spell Checker - Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) | `>= 2` |
13
+ | [cspell](https://github.com/streetsidesoftware/cspell) | `>= 8` |
14
+ | [Code Spell Checker - Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) | `>= 4` |
13
15
 
14
- ## Installation
16
+ <!--- @@inject-end: ../../static/requirements.md --->
15
17
 
16
- Global Install and add to cspell global settings.
18
+ <!--- @@inject: ./static/install.md --->
17
19
 
18
- ```sh
19
- npm install -g @cspell/dict-python
20
- cspell link add @cspell/dict-python
21
- ```
20
+ ## Local Installation
22
21
 
23
- ## Uninstall from cspell
22
+ **This package is bundled with CSpell.**
24
23
 
25
- ```sh
26
- cspell link remove @cspell/dict-python
27
- ```
24
+ ## Configuration
25
+
26
+ <details>
27
+ <summary>VSCode Settings</summary>
28
28
 
29
- ## Manual Installation
29
+ Add the following to your VSCode settings:
30
30
 
31
- The `cspell-ext.json` file in this package should be added to the import section in your cspell.json file.
31
+ **`.vscode/settings.json`**
32
32
 
33
- ```javascript
33
+ ```jsonc
34
34
  {
35
- // …
36
- "import": ["@cspell/dict-python/cspell-ext.json"],
37
- // …
35
+ "cSpell.dictionaries": ["python", "python-common"],
38
36
  }
39
37
  ```
40
38
 
41
- ## Requirements
39
+ </details>
40
+
41
+ <details>
42
+ <summary>CSpell Settings `cspell.json`</summary>
43
+
44
+ **`cspell.json`**
42
45
 
43
- Requires `cspell >= 5.5.0`
46
+ ```jsonc
47
+ {
48
+ "dictionaries": ["python", "python-common"],
49
+ }
50
+ ```
51
+
52
+ </details>
44
53
 
45
- ## Building
54
+ <details>
55
+ <summary>CSpell Settings `cspell.config.yaml`</summary>
46
56
 
47
- Building is only necessary if you want to modify the contents of the dictionary. Note: Building will take a few minutes for large files.
57
+ **`cspell.config.yaml`**
48
58
 
49
- ```sh
50
- npm run build
59
+ ```yaml
60
+ dictionaries:
61
+ - python
62
+ - python-common
51
63
  ```
52
64
 
65
+ </details>
66
+
67
+ > [!NOTE]
68
+ > **This package is bundled with CSpell.**
69
+
70
+ <!--- @@inject-end: ./static/install.md --->
71
+
72
+ <!--- @@inject: ../../static/contributing.md --->
73
+
74
+ ## Contributing
75
+
76
+ Please help correct any mistakes in the dictionaries.
77
+
78
+ See: [Contributing](https://github.com/streetsidesoftware/cspell-dicts#contributing)
79
+
80
+ Special thanks to all of our amazing contributors!
81
+
82
+ ### Dictionary Development
83
+
84
+ See: [How to Create a New Dictionary](https://github.com/streetsidesoftware/cspell-dicts#how-to-create-a-new-dictionary)
85
+
86
+ <!--- @@inject-end: ../../static/contributing.md --->
87
+
53
88
  ## License
54
89
 
55
90
  MIT
56
91
 
57
92
  > Some packages may have other licenses included.
93
+
94
+ <!--- @@inject: ../../static/footer.md --->
95
+
96
+ <br/>
97
+
98
+ ---
99
+
100
+ <p align="center">
101
+ Brought to you by <a href="https://streetsidesoftware.com" title="Street Side Software">
102
+ <img width="16" alt="Street Side Software Logo" src="https://i.imgur.com/CyduuVY.png" /> Street Side Software
103
+ </a>
104
+ </p>
105
+
106
+ <!--- @@inject-end: ../../static/footer.md --->
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cspell/dict-python",
3
- "version": "4.2.18",
3
+ "version": "4.2.19",
4
4
  "description": "Python dictionary for cspell.",
5
5
  "publishConfig": {
6
6
  "access": "public",
@@ -40,12 +40,12 @@
40
40
  },
41
41
  "homepage": "https://github.com/streetsidesoftware/cspell-dicts/blob/main/dictionaries/python#readme",
42
42
  "dependencies": {
43
- "@cspell/dict-data-science": "^2.0.8"
43
+ "@cspell/dict-data-science": "^2.0.9"
44
44
  },
45
45
  "files": [
46
46
  "dict/python.txt",
47
47
  "dict/python-common.txt",
48
48
  "cspell-ext.json"
49
49
  ],
50
- "gitHead": "5aafcca7494be9a5a12cd68e3c34103a1973fe8b"
50
+ "gitHead": "30c5c53b8e28152fc1d8a6cf0c872b068a64221a"
51
51
  }