leetcode-project-generator 1.6.0

A LeetCode project template generator.

LeetCode Project Generator

Practice LeetCode Locally with Ease

LPG is a powerful tool that facilitates the generation of local solution and test files for LeetCode problems. Say goodbye to the web-based runner and hello to seamless local development. With LPG, you can write, test, and refine your solutions in the comfort of your own environment. A CLI tool created using Click.

Installation

From PyPI

pip install leetcode-project-generator

From source

python -m pip install setuptools, build
python -m build
python -m pip install ./dist/leetcode_project_generator-*-py3-none-any.whl

Usage

[!TIP] LPG allows you to generate the project files for a given problem by just copy and pasting the URL from LeetCode!

Installed package

lpg (--title_slug <problem title> | --url <problem url>) [--directory <project directory>] [--lang <language>] [--force] [--git-init] [--git-commit] [--git-commit-message <message>]

Local package

python -m lpg (--title_slug <problem title> | --url <problem url>) [--directory <project directory>] [--lang <language>] [--force] [--git-init] [--git-commit] [--git-commit-message <message>]

Explanation

"Title slug" refers to the dashed title of the LeetCode problem which can be found in the URL of the problem. E.g. for https://leetcode.com/problems/two-sum/description/, the title slug is two-sum.

The default language is C. For an updated list of supported languages, refer to the roadmap or the related issue. If using Bash, you must surround the URL with quotes, since the & symbol would be interpreted as an asynchronous command.

The project directory defaults to ~/Documents/Coding/{language_name}/. You may use use the template {language_name} when specifying the directory, and this will automatically be translated into the name of the language specified using --lang. E.g.: cpp -> C++. The project will be created in its own directory with the name of the title slug within this directory. This is unchangeable.

Example

If you want to initialise a project for https://leetcode.com/problems/two-sum/description/, then you might type:

lpg -d /path/to/project -l c 'https://leetcode.com/problems/two-sum/description/'

This will create a directory called /path/to/project/two-sum and fill it with C language skeleton files. In this case, specifying -l c is redundant since C is the default language.

For more syntax help, use the help option.

lpg --help

or

python -m lpg --help

Roadmap

Planned available languages:

• python
• python3 (thanks @dancikmad)
• javascript
• typescript
• c
• cpp
• csharp
• java
• php
• swift
• kotlin
• dart
• golang (thanks @dancikmad)
• ruby
• scala
• rust
• racket
• erlang
• elixir

Contributing

Know any of the above langauges and want to help out? Your contributions will be greatly appreciated!

For more information on how to implement the language interface, refer to this issue. Then, fork this repository, make your changes and submit them as a pull request.

Testing

You can test all registered language interfaces (including your implementation) by running the test file found at src/lpg/interfaces/lang_test.py:

python -m unittest src.lpg.interfaces.lang_test

This uses the builtin unittest module and executes project generation for each language against an arbitrary list of LeetCode problems in a temporary directory, which is then cleaned up.

Thanks for reading!