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.12.0.tar.gz (78.7 kB view details)

Uploaded Source

Built Distribution

project_generator-0.12.0-py2.py3-none-any.whl (106.6 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: project_generator-0.12.0.tar.gz
  • Upload date:
  • Size: 78.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for project_generator-0.12.0.tar.gz
Algorithm Hash digest
SHA256 09001ea5f04fc4294ad970f84acbeec1fb937662cd7425c05f5f463385002683
MD5 9566ecda70bf253fcf6dd0574810202c
BLAKE2b-256 f447fd0cac2fff5d6a13952c6d88bb34d41572395841477f48e15db28e33b470

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for project_generator-0.12.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 8dd9b1639db4f0838f768cce0d25d0ef79a03980de53e33b7e728db755b1db3e
MD5 dcf7410c73b1f7ac9141ccca3f0bef1e
BLAKE2b-256 1dfff53d8dd8829688e78e15f7017959d3da6e25fe23a970d0ed751aae78b578

See more details on using hashes here.

Supported by

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