Skip to content

Commit

Permalink
initial commit.
Browse files Browse the repository at this point in the history
  • Loading branch information
yijiangh committed Jul 22, 2020
0 parents commit d492e50
Show file tree
Hide file tree
Showing 42 changed files with 998 additions and 0 deletions.
17 changes: 17 additions & 0 deletions .bumpversion.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
[bumpversion]
current_version = 0.1.0
message = Bump version to {new_version}
commit = True
tag = True

[bumpversion:file:setup.py]
search = version="{current_version}"
replace = version="{new_version}"

[bumpversion:file:docsource/conf.py]
search = release = "{current_version}"
replace = release = "{new_version}"

[bumpversion:file:src/compas_fab_pychoreo/__init__.py]
search = __version__ = "{current_version}"
replace = __version__ = "{new_version}"
25 changes: 25 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# http://editorconfig.org

root = true

[*]
end_of_line = lf
trim_trailing_whitespace = true
insert_final_newline = true
indent_style = space
indent_size = 4
charset = utf-8

[*.bat]
indent_style = tab
end_of_line = crlf

[*.{md,diff,patch}]
trim_trailing_whitespace = false

[Makefile]
indent_style = tab
indent_size = 4

[LICENSE]
insert_final_newline = false
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: Bug report
about: Create a report to help us improve

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Context [e.g. ST3, Rhino, Blender, ...]
2. Sample script
3. Sample data
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Python version [e.g. 2.7]
- Python package manager [e.g. macports, pip, conda]

**Additional context**
Add any other context about the problem here.
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Feature request
about: Suggest an idea for this project

---
# Feature Request

As a [role], I want [something] so that [benefit].

## Details

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is.

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
116 changes: 116 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
*.egg-info/
.installed.cfg
*.egg

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
.hypothesis/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
target/

# Jupyter Notebook
.ipynb_checkpoints

# pyenv
.python-version

# celery beat schedule file
celerybeat-schedule

# SageMath parsed files
*.sage.py

# dotenv
.env

# virtualenv
.venv
venv/
ENV/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/

# ==============================================================================
# compas_fab_pychoreo
# ==============================================================================

*.3dmbak
*.rhl
*.rui_bak

temp/**
!temp/PLACEHOLDER

.DS_Store

.vscode
15 changes: 15 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
language: python

python:
- "2.7"
- "3.6"

before_install:
- pip install --upgrade pip
- pip install Cython --install-option="--no-cython-compile"

install:
- pip install --process-dependency-links --no-cache-dir -r requirements-dev.txt

script:
- invoke test
1 change: 1 addition & 0 deletions AUTHORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Authors
Empty file added CHANGELOG.md
Empty file.
57 changes: 57 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# Contributing

Contributions are welcome and very much appreciated!

## Code contributions

We accept code contributions through pull requests.
In short, this is how that works.

1. Fork [the repository](https://github.com//compas_fab_pychoreo) and clone the fork.
2. Create a virtual environment using your tool of choice (e.g. `virtualenv`, `conda`, etc).
3. Install development dependencies:

```bash
pip install -r requirements-dev.txt
```

4. Make sure all tests pass:

```bash
invoke test
```

5. Start making your changes to the **master** branch (or branch off of it).
6. Make sure all tests still pass:

```bash
invoke test
```

7. Add yourself to the *Contributors* section of `AUTHORS.md`.
8. Commit your changes and push your branch to GitHub.
9. Create a [pull request](https://help.github.com/articles/about-pull-requests/) through the GitHub website.

During development, use [pyinvoke](http://docs.pyinvoke.org/) tasks on the
command line to ease recurring operations:

* `invoke clean`: Clean all generated artifacts.
* `invoke check`: Run various code and documentation style checks.
* `invoke docs`: Generate documentation.
* `invoke test`: Run all tests and checks in one swift command.
* `invoke`: Show available tasks.

## Bug reports

When [reporting a bug](https://github.com//compas_fab_pychoreo/issues) please include:

* Operating system name and version.
* Any details about your local setup that might be helpful in troubleshooting.
* Detailed steps to reproduce the bug.

## Feature requests

When [proposing a new feature](https://github.com//compas_fab_pychoreo/issues) please include:

* Explain in detail how it would work.
* Keep the scope as narrow as possible, to make it easier to implement.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Yijiang Huang

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
23 changes: 23 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
graft src

prune .github

prune data
prune docs
prune docsource
prune examples
prune temp
prune tests

include LICENSE
include README.md
include AUTHORS.md
include CHANGELOG.md
include requirements.txt

exclude requirements-dev.txt
exclude pytest.ini .bumpversion.cfg .editorconfig
exclude tasks.py
exclude CONTRIBUTING.md

global-exclude *.py[cod] __pycache__ *.dylib *.nb[ic] .DS_Store
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# compas_fab_pychoreo

![](https://img.shields.io/badge/compas-16.0.1-blue)
![](https://img.shields.io/badge/compas__fab-0.11.0-ff69b4)

an experimental package containing research prototpyes to integrate more planning functionalities to compas_fab
1 change: 1 addition & 0 deletions data/PLACEHOLDER
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# container for sample data files
1 change: 1 addition & 0 deletions docs/PLACEHOLDER
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# container for compiled documentation
Empty file added docsource/.nojekyll
Empty file.
1 change: 1 addition & 0 deletions docsource/PLACEHOLDER
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# container for the source files of the documentation
1 change: 1 addition & 0 deletions docsource/_images/PLACEHOLDER
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# container for images to be included in the docs
1 change: 1 addition & 0 deletions docsource/_static/PLACEHOLDER
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# container for static files, e.g. logo, banner images, javascript, stylesheets, ...
1 change: 1 addition & 0 deletions docsource/_templates/PLACEHOLDER
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# template files for Sphinx
8 changes: 8 additions & 0 deletions docsource/_templates/autosummary/base.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.. rst-class:: detail

{{ objname }}
{{ underline }}

.. currentmodule:: {{ module }}

.. auto{{ objtype }}:: {{ objname }}
Loading

0 comments on commit d492e50

Please sign in to comment.