Skip to content

Commit 6d4c2d7

Browse files
📝Chnge short description of package in setup.
Issue: #10
2 parents 6e2649a + e993310 commit 6d4c2d7

File tree

3 files changed

+53
-3
lines changed

3 files changed

+53
-3
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
.idea
22
venv
33
1buildc
4+
1build.egg-info/
5+
build/
6+
dist/
47
__pycache__/

README.md

Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,50 @@
11
# 1build
22

3-
[![Build Status](https://travis-ci.org/gopinath-langote/1build.svg?branch=master)](https://travis-ci.org/gopinath-langote/1build)
3+
[![Build Status](https://travis-ci.org/gopinath-langote/1build.svg?branch=master)](https://travis-ci.org/gopinath-langote/1build)
4+
5+
A simple way to unify build commands across all your projects running original building steps with all their specifics under the hood. It is agnostic to the underlying build tool, and environment preparatory steps are supported too.
6+
7+
## Why?
8+
9+
Imagine you are a microservices developer switching around multiple projects written in different languages and built with different building processes. Instead of reading README files all the time learning the specifics of how to run every one of them – you can just capture the configuration once and then use a single unified build command.
10+
11+
With the support of preparatory and clean up steps – you can include various environment preparations and have them run as part of the build.
12+
13+
## Install
14+
15+
```bash
16+
pip install 1build
17+
```
18+
19+
or
20+
21+
```bash
22+
pip3 install 1build
23+
```
24+
25+
## Usage
26+
27+
### Configuration
28+
29+
- сreate project configuration file in the project folder
30+
- file name: `1build.yaml`
31+
32+
Example of `1build.yaml` for JVM maven project:
33+
```yaml
34+
project: Sample JVM Project Name
35+
commands:
36+
- build: mvn clean package
37+
- lint: mvn antrun:run@ktlint-format
38+
```
39+
40+
Running 1build for above sample project:
41+
42+
- building the project
43+
```bash
44+
1build build
45+
```
46+
47+
- reformat the code lint
48+
```bash
49+
1build lint
50+
```

setup.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44
long_description = fh.read()
55
setuptools.setup(
66
name='1build',
7-
version='0.0.1',
7+
version='0.0.2',
88
scripts=['1build'],
99
license="MIT License",
1010
author="Gopinath Langote",
1111
install_requires=[
1212
'ruamel.yaml>=0.15.94'
1313
],
1414
author_email="[email protected]",
15-
description="Unified build tool for all project needs.",
15+
description="Unified build command for all project using underlying different build tools.",
1616
long_description=long_description,
1717
long_description_content_type="text/markdown",
1818
url="https://github.com/gopinath-langote/1build",

0 commit comments

Comments
 (0)