Home

Welcome to Nirjas documentation!

Nirjas ~ নির্যাস

A Python library for Comments and Source Code Extraction

✨ 🍰 ✨            

Description

A source code file usually contains various vital information such as license text, function/class documentation, code/logic explanation, etc in the form of comments (block & line).

Nirjas is a fully dedicated python library to extract the comments and source code out of your file(s). The extracted comments can be processed in various ways to detect licenses, generate documentation, process info, etc.

Apart from that, the library serves you with all the required metadata about your Code, Comments and File(s) along with the extraction.

User Documentation

• Contacts, Informations and Discussion Forums
• Nirjas Installation Guide
  • Install Nirjas using pip
  • Install Nirjas using source
• Usage Guide
  • Example Usage
• Output Format
  • From a Single File
  • From a Directory
  • Extract Source Code

Developer Documentation

• Setting up Python Virtual Environment
• Contribute to Nirjas
  • CONTRIBUTING.md
  • Code Guidelines
  • Git Commit Convention
• Report an Issue
• Create a Pull Request

Meta Information

• About
• Release Notes
• LICENSE

Nirjas is licensed under the GNU Lesser General Public License v2.1

Acknowledgement 📝

The references and documentation style is taken directly from FOSSology & Atarashi wiki.

I thank all the developers, contributors and maintainers of FOSSology, Atarashi & Nirjas for their valuable contribution to the project. 🧑‍💻

🚧 Please note that this wiki is actively maintained and still growing 🌱 , so please help us add anything that you feel would be useful! You can read more information about how to contribute in our Contributing Guide.