Skip to main content

Project generators for various embedded tools (IDE). IAR, uVision, Makefile and many more in the roadmap!

Project description

Project generator

Build Status

Source code is often times simple but building it is difficult when more than one person is involved. Developers like what they like: IDE, compiler, debugger and really all we want is to produce an executable. Sharing project files decoding XML in commit messages because someone was debugging and changed compile options before commiting distracts from doing what you want to do; develop software.

This project allows you to define a project in text using YAML files and generate IDE project files based on the rules defined in records. No one should ever commit IDE specific project file to a repository again!

All open sourced - licensed under Apache v2.0 license.

Current Status

The project is in alpha phase. Check issues for the ongoing tasks or todo tasks.

Project generator currently generaters projects for the following tools (IDE, Makefile, etc..):

  • uVision4 and uVision5
  • IAR
  • Makefile (GCC ARM)
  • Makefile (ARMCC)
  • Cmake (GCC ARM)
  • CoIDE (GCC ARM)
  • Eclipse (Makefile with GCC ARM)
  • Sublime (Makefile with GCC ARM)
  • Visual studio (Makefile with GCC ARM)

We appreciate any help and you are more than welcome to send a pull request or create a new issue in this repository. The plan is to support as many IDE as possible , same applies for targets/MCU.

How to use it

There are two options, how to use it. Either you download pypi package or you can clone this repository to your project directory.

Using package

Once installed, test if project_generator is recognized:

progen --version

This should print the current installed version. You can use progen or project_generator as a command.

Using directly the repository

In case of using this repository directly, be aware, the project generator is using relative paths. To solve this, invoke run.py with arguments as you would if using the package. Something like: python run.py --version. This helps with debugging the package.

Getting started

An example how to use progen baremetal blinky examples or more advanced mbed blinky examples.

Docs

To get familiar with it, read our wiki. Good start is Getting started guide (wiki). There are other sections which describe the each blocks of the project generator.

Add a new target/mcu

We use project generator definitions, which is a separate python module and contains mcu/target database plus parser to obtain those from tools projects, visit github page here.

Dependencies for Project generator

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

project_generator-0.11.1.tar.gz (68.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

project_generator-0.11.1-py2.py3-none-any.whl (106.1 kB view details)

Uploaded Python 2Python 3

File details

Details for the file project_generator-0.11.1.tar.gz.

File metadata

  • Download URL: project_generator-0.11.1.tar.gz
  • Upload date:
  • Size: 68.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.0

File hashes

Hashes for project_generator-0.11.1.tar.gz
Algorithm Hash digest
SHA256 cbfb71fb0b27187466ebce47b2c8afb8370ffbdbd953985e0702915276855e44
MD5 0614374c4667e6ae1a26570a1676ce30
BLAKE2b-256 f74c001e90e89dcbfc34def7ef688ebf306098dad856ffd8d584fd4b2f0d8488

See more details on using hashes here.

File details

Details for the file project_generator-0.11.1-py2.py3-none-any.whl.

File metadata

  • Download URL: project_generator-0.11.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 106.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.0

File hashes

Hashes for project_generator-0.11.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 89ac89472a23580e8d19e95fa6e5749e28d6cb1fc579034a1c0ac150363f20ec
MD5 a6ee89ccdf41d1f02857574076f1da74
BLAKE2b-256 fe8cc49ea7977a3bd62b8f17a065675032963b6d3bc95904ebfa91c9e7208c3f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page