Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# This is a skeleton Travis CI config file that provides a starting point for adding CI
# to a Python project. Since we primarily develop in python3, this skeleton config file
# will be specific to that language.
#
# See https://config.travis-ci.com/ for a full list of configuration options.

os: linux

dist: xenial

language: python
python:
- "3.6"
- "3.7"
- "3.8"

# Scripts to run at install stage
install: ./configure

# Scripts to run at script stage
script: tmp/bin/pytest
34 changes: 3 additions & 31 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,31 +1,3 @@
A Simple Python Project Skeleton
================================
This repo attempts to standardize our python repositories using modern python
packaging and configuration techniques. Using this `blog post`_ as inspiration, this
repository will serve as the base for all new python projects and will be adopted to all
our existing ones as well.

.. _blog post: https://blog.jaraco.com/a-project-skeleton-for-python-projects/

Usage
=====
A brand new project
-------------------
.. code-block:: bash

git init my-new-repo
cd my-new-repo
git pull git@github.com:nexB/skeleton

From here, you can make the appropriate changes to the files for your specific project.

Update an existing project
---------------------------
.. code-block:: bash

cd my-existing-project
git remote add skeleton git@github.com:nexB/skeleton
git fetch skeleton
git merge skeleton --allow-unrelated-histories

This is also the workflow to use when updating the skeleton files in any given repository.
extractcode
===========
A set of functions and utilities used to extract archives.