GitXplorerGitXplorer
b

py-struct

public
0 stars
2 forks
0 issues

Commits

List of commits on branch master.
Unverified
f1cea4c469641ebd8c9c980a956d7a67f7d4a2b9

Updated chalk to version 2

bbarslev committed 5 years ago
Unverified
239066a09285f086923c810e48b0ea25e7c7326a

new version

ccristian-rincon committed 5 years ago
Unverified
562b97611fd89d4b67f3fb947ad14981809d3a38

fixing error

ccristian-rincon committed 5 years ago
Verified
737e66a4d6cd392c8ad9369058ff79a217f28c64

Update npmpublish.yml

ccristian-rincon committed 5 years ago
Verified
4ea6c299e9c80b71c266b83f3a8cd3949c648994

Create npmpublish.yml

ccristian-rincon committed 5 years ago
Unverified
e13745843b6337d904aa3de21850db22e4ef421a

new revision

ccristian-rincon committed 5 years ago

README

The README file for this repository.

Py-struct

Project Status travis appveyor codecov npm version npm download

Introduction

py-struct is a yeoman-generator for Python projects using setuptools. Projects created with py-struct are ready for publication to pypi and conda. The generator creates a package barebone that support:

  • a standard setup.py, MANIFEST.in.
  • project automationg tox.
  • static code analysis and reports using pylint.
  • a unit-test suite using pytest/unittest,
  • build.sh for conda packages,
  • documentation with readthedocs.io and sphinx,
  • custom README.md, and VERSIONS.md files,
  • .gitignore, .gitattributes, coveragerc,

The resulting folder-structure looks like this:

  .
  ├── build.sh
  ├── credentials.json
  ├── docs
  │   ├── Makefile
  │   └── source
  │       ├── conf.py
  │       ├── examples.rst
  │       ├── index.rst
  │       ├── modules.rst
  │       └── tutorial.rst
  ├── emptyproject.py
  ├── gitattributes
  ├── gitignore
  ├── __init__.py
  ├── LICENSE
  ├── MANIFEST.in
  ├── prepare_environment.sh
  ├── pylintrc
  ├── README.rst
  ├── run_test.sh
  ├── setup.py
  ├── test.py
  ├── tree
  └── VERSIONS.md

Installation

Yeoman comes with npm, so install it first and then call:

  npm install -g yo
  npm install -g generator-py-struct

Once you have the package, you can create a scaffold using:

  yo py-struct

This builds the skeleton. Afterwards modify the sources and documentation and build both using:

  ./prepare_environment.sh
  cd docs && make html

Author