Get a license from the GitHub API
Project description
class_d
An interactive utility for creating GitHub-style licenses locally with date and name.
Requirements
- Python version 3.6 or higher
- Requests*
- python-inquirer*
* pip
will install these automatically.
Installation
python -m pip install class-d-oliversandli
Note that installation with sudo
will add class_d
to /usr/local/bin
. Without sudo
, pip
installs scripts to ~/.local/bin
. Many Linux distros do not have ~/.local/bin
already in their path, so to use class_d
after a sudo
-less install, add ~/.local/bin
to your PATH
variable.
Setup
class_d
will perform all necessary setup on first run.
Usage
class_d
as a Program
class_d
-f
--favorite
Create a LICENSE
file specified by "favorite"
in ~/.config/class_d/settings.json
.
class_d
as a Library
#!/usr/bin/env python3
"""example file"""
import class_d
if __name__ == "__main__":
license_list = class_d.get_license_list()
specific_license = class_d.get_license(license_list["MIT"])
get_license_list()
Return a dictionary of license names and GitHub API keys from https://api.github.com/licenses.
{'AGPL-3.0': 'agpl-3.0',
'Apache-2.0': 'apache-2.0',
'BSD-2-Clause': 'bsd-2-clause',
'BSD-3-Clause': 'bsd-3-clause',
'CC0-1.0': 'cc0-1.0',
'EPL-2.0': 'epl-2.0',
'GPL-2.0': 'gpl-2.0',
'GPL-3.0': 'gpl-3.0',
'LGPL-2.1': 'lgpl-2.1',
'LGPL-3.0': 'lgpl-3.0',
'MIT': 'mit',
'MPL-2.0': 'mpl-2.0',
'Unlicense': 'unlicense'}
get_license(key)
Return the body
of a license from https://api.github.com/licenses/{key}
.
get_license("mit")
"MIT License\n\nCopyright (c) [year] [fullname]\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n"
TODO
- Add
-f
flag to use favorite license. - Complete documentation in README.
- Complete PEP-8 compliance.
- Full
argparse
for--help
support. - Provide library for useful functions.
- Distribute on
pip
.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for class_d-oliversandli-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e4e8ac9b2124470c3a3a39db7d8a60aa61287129551c30b492b27f614587705a |
|
MD5 | d4282bf18fd2d1b1473a206e9ae9ad0f |
|
BLAKE2b-256 | 8426b51b3d8e1b9d85acefdc758d90cbd87430b9d696ff7544a491922e8334e8 |