Code Monkey home page Code Monkey logo

class_d's Introduction

class_d

icon

python PEP8 license

An interactive utility for creating GitHub-style licenses locally with date and name.

Requirements

* pip will install these automatically.

Installation

python -m pip install -U class-d-oliversandli

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 Ctrl-C handling to prevent messy cancels.
  • Add -f flag to use favorite license.
  • Complete documentation in README.
  • Complete PEP-8 compliance.
  • Full argparse for --help support.

class_d's People

Contributors

oliverdelancey avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.