https://github.com/sanjaysunil/licenseme

🏷 Your handy tool for licensing and protecting your code.
https://github.com/sanjaysunil/licenseme

adder copyright license licenseme prepender python tool

Last synced: 8 months ago
JSON representation

🏷 Your handy tool for licensing and protecting your code.

• Host: GitHub
• URL: https://github.com/sanjaysunil/licenseme
• Owner: SanjaySunil
• License: mit
• Created: 2020-12-15T21:07:35.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2022-08-09T09:26:31.000Z (about 3 years ago)
• Last Synced: 2025-01-08T08:45:35.215Z (9 months ago)
• Topics: adder, copyright, license, licenseme, prepender, python, tool
• Language: Python
• Homepage:
• Size: 135 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          



  

    

  



LicenseMe

  


    Your handy tool for licensing and protecting your code.

    


    Report Bug

    ·

    Request Feature

  






## What's README Template?

[**LicenseMe**](https://github.com/SanjaySunil/LicenseMe) is a fast copyright prepender tool that allows you to add custom copyright notices/licenses or information at the top of each file of your code. 

**At the moment, the current presets for this tool are for JS.** More updates for customisation will be released soon.




## ✨ Features

- ⚡ **Fast Prepending:** LicenseMe adds licenses at the top of your code within seconds.

- ⚙ **Customisable:** LicenseMe's settings can be altered in the `config.json` file.




## Getting started

> Simply open and configure the config.json. Then, open copyright.py and let the magic begin!




### Prerequisites

Python 3.x




### Installation

1. Clone LicenseMe

```sh

git clone https://github.com/SanjaySunil/LicenseMe

```

2. Open and configure `config.json` with your options.

3. Run `copyright.py`.

4. Check code to make sure all files have been licensed.




## Roadmap

See the [open issues](https://github.com/SanjaySunil/LicenseMe/issues) for a list of proposed features (and known issues).




## Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.

1. Fork the Project

2. Create your Feature Branch (`git checkout -b feature/Feature`)

3. Commit your Changes (`git commit -m 'Added a new Feature'`)

4. Push to the Branch (`git push origin feature/Feature`)

5. Open a Pull Request




## License

Copyright © 2022 Sanjay Sunil (sanjaysunil@protonmail.com)

Distributed under the MIT License. See `LICENSE` for more information.