Project generators for various embedded tools (IDE). IAR, uVision, Makefile and many more in the roadmap!
Project description
# Project generator
[![Build Status](https://travis-ci.org/0xc0170/project_generator.svg)](https://travis-ci.org/0xc0170/project_generator)
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..):
- uVision
- Makefile (GCC ARM)
- IAR
- CoIDE (GCC ARM)
- Eclipse (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 boards/MCU.
### How to use it
There are two options, how to use it. Either you download [pypi package](https://pypi.python.org/pypi/project_generator) or you can clone this repository to your project directory.
##### Using package
Once installed, test if project_generator is recognized:
```
project_generator --version
```
This should print the current installed version.
##### Using directly the repository
In case of using this repository directly, be aware, the project generator is using relative paths. To solve this, create a simple run.py script and place there:
```
from project_generator.main import main
main()
```
Then just invoke run.py with arguments as you would if using the package. Something like: python run.py --version
There are examples in c0170 github, so check them out!
To get familiar with it, read our wiki. Good start is [Getting started guide (wiki)](https://github.com/0xc0170/project_generator/wiki/Getting_started). There are other sections which describe the each blocks of the project generator.
Dependencies for Project generator
-------------------------
* Python 2.7
* [pyYAML](https://github.com/yaml/pyyaml)
* [Setuptools](https://pypi.python.org/pypi/distribute)
* [Jinja2](https://pypi.python.org/pypi/Jinja2)
[![Build Status](https://travis-ci.org/0xc0170/project_generator.svg)](https://travis-ci.org/0xc0170/project_generator)
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..):
- uVision
- Makefile (GCC ARM)
- IAR
- CoIDE (GCC ARM)
- Eclipse (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 boards/MCU.
### How to use it
There are two options, how to use it. Either you download [pypi package](https://pypi.python.org/pypi/project_generator) or you can clone this repository to your project directory.
##### Using package
Once installed, test if project_generator is recognized:
```
project_generator --version
```
This should print the current installed version.
##### Using directly the repository
In case of using this repository directly, be aware, the project generator is using relative paths. To solve this, create a simple run.py script and place there:
```
from project_generator.main import main
main()
```
Then just invoke run.py with arguments as you would if using the package. Something like: python run.py --version
There are examples in c0170 github, so check them out!
To get familiar with it, read our wiki. Good start is [Getting started guide (wiki)](https://github.com/0xc0170/project_generator/wiki/Getting_started). There are other sections which describe the each blocks of the project generator.
Dependencies for Project generator
-------------------------
* Python 2.7
* [pyYAML](https://github.com/yaml/pyyaml)
* [Setuptools](https://pypi.python.org/pypi/distribute)
* [Jinja2](https://pypi.python.org/pypi/Jinja2)
Project details
Release history Release notifications | RSS feed
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.5.1.zip
(64.4 kB
view hashes)