@@ -7,71 +7,71 @@ Packageinfo
77> Auto-generated documentation for [ licensecheck.packageinfo] ( ../../../licensecheck/packageinfo.py ) module.
88
99- [ Packageinfo] ( #packageinfo )
10- - [ getClassifiersLicense] ( #getclassifierslicense )
1110 - [ getModuleSize] ( #getmodulesize )
1211 - [ getMyPackageLicense] ( #getmypackagelicense )
12+ - [ getMyPackageMetadata] ( #getmypackagemetadata )
1313 - [ getPackageInfoLocal] ( #getpackageinfolocal )
1414 - [ getPackageInfoPypi] ( #getpackageinfopypi )
1515 - [ getPackages] ( #getpackages )
1616 - [ licenseFromClassifierlist] ( #licensefromclassifierlist )
1717
18- ## getClassifiersLicense
18+ ## getModuleSize
19+
20+ [ Show source in packageinfo.py:160] ( ../../../licensecheck/packageinfo.py#L160 )
1921
20- [ Show source in packageinfo.py:121 ] ( ../../../licensecheck/packageinfo.py#L121 )
22+ Get the size of a given module as an int.
2123
22- Get the package classifiers and license from "setup.cfg", "pyproject.toml" or user input
24+ #### Arguments
25+
26+ - ` path ` * Path* - path to package
27+ - ` name ` * str* - name of package
2328
2429#### Returns
2530
26- - ` dict[str, ` * Any ] * - {"classifiers": set [ str ] , "license": str}
31+ - ` int ` - size in bytes
2732
2833#### Signature
2934
3035``` python
31- def getClassifiersLicense ( ) -> dict[ str , Any] :
36+ def getModuleSize ( path : Path, name : str ) -> int :
3237 ...
3338```
3439
3540
3641
37- ## getModuleSize
38-
39- [ Show source in packageinfo.py:163] ( ../../../licensecheck/packageinfo.py#L163 )
40-
41- Get the size of a given module as an int.
42+ ## getMyPackageLicense
4243
43- #### Arguments
44+ [ Show source in packageinfo.py:143 ] ( ../../../licensecheck/packageinfo.py#L143 )
4445
45- - ` path ` * Path* - path to package
46- - ` name ` * str* - name of package
46+ Get the package license from "setup.cfg", "pyproject.toml" or user input
4747
4848#### Returns
4949
50- - ` int ` - size in bytes
50+ - ` str ` - license name
5151
5252#### Signature
5353
5454``` python
55- def getModuleSize ( path : Path, name : str ) -> int :
55+ def getMyPackageLicense ( ) -> str :
5656 ...
5757```
5858
5959
6060
61- ## getMyPackageLicense
61+ ## getMyPackageMetadata
6262
63- [ Show source in packageinfo.py:145 ] ( ../../../licensecheck/packageinfo.py#L145 )
63+ [ Show source in packageinfo.py:119 ] ( ../../../licensecheck/packageinfo.py#L119 )
6464
65- Get the package license from "setup.cfg", "pyproject.toml" or user input
65+ Get the package classifiers and license from "setup.cfg", "pyproject.toml"
6666
6767#### Returns
6868
69- - ` str ` - license name
69+ - ` dict[ str, ` * Any ] * - {"classifiers": list [ str ] , " license": str}
7070
7171#### Signature
7272
7373``` python
74- def getMyPackageLicense () -> str :
74+ def getMyPackageMetadata () -> dict[ str , Any] :
7575 ...
7676```
7777
@@ -112,7 +112,7 @@ def getPackageInfoLocal(requirement: str) -> PackageInfo:
112112
113113## getPackageInfoPypi
114114
115- [ Show source in packageinfo.py:55 ] ( ../../../licensecheck/packageinfo.py#L55 )
115+ [ Show source in packageinfo.py:54 ] ( ../../../licensecheck/packageinfo.py#L54 )
116116
117117Get package info from local files including version, author
118118and the license.
@@ -145,7 +145,7 @@ def getPackageInfoPypi(requirement: str) -> PackageInfo:
145145
146146## getPackages
147147
148- [ Show source in packageinfo.py:99 ] ( ../../../licensecheck/packageinfo.py#L99 )
148+ [ Show source in packageinfo.py:97 ] ( ../../../licensecheck/packageinfo.py#L97 )
149149
150150Get dependency info.
151151
@@ -172,7 +172,7 @@ def getPackages(reqs: set[str]) -> set[PackageInfo]:
172172
173173## licenseFromClassifierlist
174174
175- [ Show source in packageinfo.py:81 ] ( ../../../licensecheck/packageinfo.py#L81 )
175+ [ Show source in packageinfo.py:79 ] ( ../../../licensecheck/packageinfo.py#L79 )
176176
177177Get license string from a list of project classifiers.
178178
0 commit comments