Skip to content

Commit b3ae862

Browse files
tlirontliron
committed
Initial commit
0 parents  commit b3ae862

22 files changed

+1243
-0
lines changed

‎.gitignore

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
*.pyc
2+
3+
**/*.egg-info/
4+
**/build/
5+
**/.ninja*
6+
7+
env/
8+
docs/
9+
out/
10+
dist/
11+
12+
**/cubism/
13+
14+
.tox/
15+
.coverage
16+
17+
*.geany
18+
*.csv
19+
20+
.DS_Store
21+
22+
.idea/

‎.project

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<projectDescription>
3+
<name>Ronin</name>
4+
<comment></comment>
5+
<projects>
6+
</projects>
7+
<buildSpec>
8+
<buildCommand>
9+
<name>org.python.pydev.PyDevBuilder</name>
10+
<arguments>
11+
</arguments>
12+
</buildCommand>
13+
</buildSpec>
14+
<natures>
15+
<nature>org.python.pydev.pythonNature</nature>
16+
</natures>
17+
</projectDescription>

‎.pydevproject

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
2+
<?eclipse-pydev version="1.0"?><pydev_project>
3+
<pydev_pathproperty name="org.python.pydev.PROJECT_SOURCE_PATH">
4+
<path>/${PROJECT_DIR_NAME}</path>
5+
<path>/${PROJECT_DIR_NAME}/env/lib/python2.7/site-packages</path>
6+
</pydev_pathproperty>
7+
<pydev_property name="org.python.pydev.PYTHON_PROJECT_VERSION">python 2.7</pydev_property>
8+
<pydev_property name="org.python.pydev.PYTHON_PROJECT_INTERPRETER">Default</pydev_property>
9+
</pydev_project>

‎LICENSE

Lines changed: 191 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction, and
10+
distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by the copyright
13+
owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all other entities
16+
that control, are controlled by, or are under common control with that entity.
17+
For the purposes of this definition, "control" means (i) the power, direct or
18+
indirect, to cause the direction or management of such entity, whether by
19+
contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
20+
outstanding shares, or (iii) beneficial ownership of such entity.
21+
22+
"You" (or "Your") shall mean an individual or Legal Entity exercising
23+
permissions granted by this License.
24+
25+
"Source" form shall mean the preferred form for making modifications, including
26+
but not limited to software source code, documentation source, and configuration
27+
files.
28+
29+
"Object" form shall mean any form resulting from mechanical transformation or
30+
translation of a Source form, including but not limited to compiled object code,
31+
generated documentation, and conversions to other media types.
32+
33+
"Work" shall mean the work of authorship, whether in Source or Object form, made
34+
available under the License, as indicated by a copyright notice that is included
35+
in or attached to the work (an example is provided in the Appendix below).
36+
37+
"Derivative Works" shall mean any work, whether in Source or Object form, that
38+
is based on (or derived from) the Work and for which the editorial revisions,
39+
annotations, elaborations, or other modifications represent, as a whole, an
40+
original work of authorship. For the purposes of this License, Derivative Works
41+
shall not include works that remain separable from, or merely link (or bind by
42+
name) to the interfaces of, the Work and Derivative Works thereof.
43+
44+
"Contribution" shall mean any work of authorship, including the original version
45+
of the Work and any modifications or additions to that Work or Derivative Works
46+
thereof, that is intentionally submitted to Licensor for inclusion in the Work
47+
by the copyright owner or by an individual or Legal Entity authorized to submit
48+
on behalf of the copyright owner. For the purposes of this definition,
49+
"submitted" means any form of electronic, verbal, or written communication sent
50+
to the Licensor or its representatives, including but not limited to
51+
communication on electronic mailing lists, source code control systems, and
52+
issue tracking systems that are managed by, or on behalf of, the Licensor for
53+
the purpose of discussing and improving the Work, but excluding communication
54+
that is conspicuously marked or otherwise designated in writing by the copyright
55+
owner as "Not a Contribution."
56+
57+
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
58+
of whom a Contribution has been received by Licensor and subsequently
59+
incorporated within the Work.
60+
61+
2. Grant of Copyright License.
62+
63+
Subject to the terms and conditions of this License, each Contributor hereby
64+
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
65+
irrevocable copyright license to reproduce, prepare Derivative Works of,
66+
publicly display, publicly perform, sublicense, and distribute the Work and such
67+
Derivative Works in Source or Object form.
68+
69+
3. Grant of Patent License.
70+
71+
Subject to the terms and conditions of this License, each Contributor hereby
72+
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
73+
irrevocable (except as stated in this section) patent license to make, have
74+
made, use, offer to sell, sell, import, and otherwise transfer the Work, where
75+
such license applies only to those patent claims licensable by such Contributor
76+
that are necessarily infringed by their Contribution(s) alone or by combination
77+
of their Contribution(s) with the Work to which such Contribution(s) was
78+
submitted. If You institute patent litigation against any entity (including a
79+
cross-claim or counterclaim in a lawsuit) alleging that the Work or a
80+
Contribution incorporated within the Work constitutes direct or contributory
81+
patent infringement, then any patent licenses granted to You under this License
82+
for that Work shall terminate as of the date such litigation is filed.
83+
84+
4. Redistribution.
85+
86+
You may reproduce and distribute copies of the Work or Derivative Works thereof
87+
in any medium, with or without modifications, and in Source or Object form,
88+
provided that You meet the following conditions:
89+
90+
You must give any other recipients of the Work or Derivative Works a copy of
91+
this License; and
92+
You must cause any modified files to carry prominent notices stating that You
93+
changed the files; and
94+
You must retain, in the Source form of any Derivative Works that You distribute,
95+
all copyright, patent, trademark, and attribution notices from the Source form
96+
of the Work, excluding those notices that do not pertain to any part of the
97+
Derivative Works; and
98+
If the Work includes a "NOTICE" text file as part of its distribution, then any
99+
Derivative Works that You distribute must include a readable copy of the
100+
attribution notices contained within such NOTICE file, excluding those notices
101+
that do not pertain to any part of the Derivative Works, in at least one of the
102+
following places: within a NOTICE text file distributed as part of the
103+
Derivative Works; within the Source form or documentation, if provided along
104+
with the Derivative Works; or, within a display generated by the Derivative
105+
Works, if and wherever such third-party notices normally appear. The contents of
106+
the NOTICE file are for informational purposes only and do not modify the
107+
License. You may add Your own attribution notices within Derivative Works that
108+
You distribute, alongside or as an addendum to the NOTICE text from the Work,
109+
provided that such additional attribution notices cannot be construed as
110+
modifying the License.
111+
You may add Your own copyright statement to Your modifications and may provide
112+
additional or different license terms and conditions for use, reproduction, or
113+
distribution of Your modifications, or for any such Derivative Works as a whole,
114+
provided Your use, reproduction, and distribution of the Work otherwise complies
115+
with the conditions stated in this License.
116+
117+
5. Submission of Contributions.
118+
119+
Unless You explicitly state otherwise, any Contribution intentionally submitted
120+
for inclusion in the Work by You to the Licensor shall be under the terms and
121+
conditions of this License, without any additional terms or conditions.
122+
Notwithstanding the above, nothing herein shall supersede or modify the terms of
123+
any separate license agreement you may have executed with Licensor regarding
124+
such Contributions.
125+
126+
6. Trademarks.
127+
128+
This License does not grant permission to use the trade names, trademarks,
129+
service marks, or product names of the Licensor, except as required for
130+
reasonable and customary use in describing the origin of the Work and
131+
reproducing the content of the NOTICE file.
132+
133+
7. Disclaimer of Warranty.
134+
135+
Unless required by applicable law or agreed to in writing, Licensor provides the
136+
Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
137+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
138+
including, without limitation, any warranties or conditions of TITLE,
139+
NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
140+
solely responsible for determining the appropriateness of using or
141+
redistributing the Work and assume any risks associated with Your exercise of
142+
permissions under this License.
143+
144+
8. Limitation of Liability.
145+
146+
In no event and under no legal theory, whether in tort (including negligence),
147+
contract, or otherwise, unless required by applicable law (such as deliberate
148+
and grossly negligent acts) or agreed to in writing, shall any Contributor be
149+
liable to You for damages, including any direct, indirect, special, incidental,
150+
or consequential damages of any character arising as a result of this License or
151+
out of the use or inability to use the Work (including but not limited to
152+
damages for loss of goodwill, work stoppage, computer failure or malfunction, or
153+
any and all other commercial damages or losses), even if such Contributor has
154+
been advised of the possibility of such damages.
155+
156+
9. Accepting Warranty or Additional Liability.
157+
158+
While redistributing the Work or Derivative Works thereof, You may choose to
159+
offer, and charge a fee for, acceptance of support, warranty, indemnity, or
160+
other liability obligations and/or rights consistent with this License. However,
161+
in accepting such obligations, You may act only on Your own behalf and on Your
162+
sole responsibility, not on behalf of any other Contributor, and only if You
163+
agree to indemnify, defend, and hold each Contributor harmless for any liability
164+
incurred by, or claims asserted against, such Contributor by reason of your
165+
accepting any such warranty or additional liability.
166+
167+
END OF TERMS AND CONDITIONS
168+
169+
APPENDIX: How to apply the Apache License to your work
170+
171+
To apply the Apache License to your work, attach the following boilerplate
172+
notice, with the fields enclosed by brackets "[]" replaced with your own
173+
identifying information. (Don't include the brackets!) The text should be
174+
enclosed in the appropriate comment syntax for the file format. We also
175+
recommend that a file or class name and description of purpose be included on
176+
the same "printed page" as the copyright notice for easier identification within
177+
third-party archives.
178+
179+
Copyright [yyyy] [name of copyright owner]
180+
181+
Licensed under the Apache License, Version 2.0 (the "License");
182+
you may not use this file except in compliance with the License.
183+
You may obtain a copy of the License at
184+
185+
http://www.apache.org/licenses/LICENSE-2.0
186+
187+
Unless required by applicable law or agreed to in writing, software
188+
distributed under the License is distributed on an "AS IS" BASIS,
189+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
190+
See the License for the specific language governing permissions and
191+
limitations under the License.

‎README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
Ronin
2+
=====
3+
4+
A straightforward but powerful build system based on [Ninja](https://ninja-build.org/) and Python.
5+
6+
"Based on Python" means that not only is it written in Python, but also it uses Python as the DSL
7+
for build scripts. Many build systems invent their own DSLs, but Ronin intentionally builds on a
8+
language that already exists. Note that you _don't_ need to be an expert in Python to use Ronin,
9+
but the power is there if you need it.
10+
11+
Goals:
12+
13+
1. **Easy to use**: _optional_ auto-configuration with sensible, _overridable_ defaults: detect
14+
`ccache`, support `pkg-config`, etc.
15+
2. **Complex does not have to mean complicated**: handle cross-compilations and other
16+
multi-configuration builds as single projects with minimal duplication of effort.
17+
18+
The design principles:
19+
20+
1. Pour some sugar on me: make common tasks easier with sweet and coherent helper. But make sure
21+
that sugar is optional, allowing the script to be more verbose if it's helpful.
22+
2. Don't hide functionality behind complexity: for example, if the user wants to manipulate a
23+
compiler command line, let them do it easily. Too many build systems bungle this and make it
24+
either impossible or very difficult to do something that would be trivial using a shell script.
25+
3. Don't reinvent wheels: if Python or Ninja do something for us, use it. The build script is a
26+
plain Python program with no unnecessary cleverness. The generated Ninja script looks like
27+
something you could have created manually.
28+
29+
Similar Projects
30+
----------------
31+
32+
* [Meson](http://mesonbuild.com/): another Python frontend for Ninja, very high-level, fairly easy
33+
to use
34+
* [Craftr](https://github.com/craftr-build/craftr): another Python frontend for Ninja, more
35+
low-level than Meson, but also more complicated to use
36+
* [CMake](https://cmake.org/): can work as a frontend for Ninja
37+
* [Waf](https://waf.io/): a big Python build system (and platform for build systems)

‎examples/gtk/build1.py

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
#!/usr/bin/env python
2+
3+
#
4+
# GTK+ Hello World
5+
#
6+
# build1.py
7+
#
8+
# Source: https://developer.gnome.org/gtk3/stable/gtk-getting-started.html
9+
#
10+
# This is the simplest possible version, using all the sensible defaults.
11+
#
12+
13+
from ronin import configure_build
14+
from ronin.cli import build_cli
15+
from ronin.contexts import new_context
16+
from ronin.gcc import GccBuild
17+
from ronin.pkg_config import Package
18+
from ronin.projects import Project
19+
from ronin.rules import Rule
20+
from ronin.utils import base_path, glob
21+
22+
with new_context() as ctx:
23+
configure_build(ctx, base_path(__file__))
24+
25+
p = Project('example_1')
26+
27+
c = GccBuild()
28+
c.add_libraries(Package('gtk+-3.0'))
29+
30+
r = Rule(c)
31+
r.inputs = glob('*.c')
32+
r.output = 'example_1'
33+
34+
p.rules['executable'] = r
35+
36+
build_cli(p)

‎examples/gtk/build2.py

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
#!/usr/bin/env python
2+
3+
#
4+
# GTK+ Hello World
5+
#
6+
# build2.py
7+
#
8+
# Source: https://developer.gnome.org/gtk3/stable/gtk-getting-started.html
9+
#
10+
# This improves on build1.py by adding explicit configuration of all utilities.
11+
#
12+
13+
from ronin import configure_build
14+
from ronin.cli import build_cli
15+
from ronin.contexts import new_context
16+
from ronin.gcc import configure_gcc, GccBuild
17+
from ronin.pkg_config import configure_pkg_config, Package
18+
from ronin.projects import Project
19+
from ronin.ninja import configure_ninja
20+
from ronin.rules import Rule
21+
from ronin.utils import base_path, glob
22+
23+
with new_context() as ctx:
24+
configure_build(ctx,
25+
base_path(__file__),
26+
output_path_relative='build',
27+
binary_path_relative='bin',
28+
debug=True)
29+
configure_ninja(ctx,
30+
command='ninja',
31+
file_name='build.ninja',
32+
columns=100)
33+
configure_gcc(ctx,
34+
command='gcc',
35+
ccache=True)
36+
configure_pkg_config(ctx,
37+
command='pkg-config',
38+
path=None)
39+
40+
p = Project('example_1')
41+
42+
c = GccBuild()
43+
c.add_libraries(Package('gtk+-3.0'))
44+
45+
r = Rule(c)
46+
r.inputs = glob('*.c')
47+
r.output = 'example_1'
48+
49+
p.rules['executable'] = r
50+
51+
build_cli(p)

0 commit comments

Comments
 (0)