Skip to content

Commit

Permalink
Merge pull request #26 from pinax/django-upgrade
Browse files Browse the repository at this point in the history
Django upgrade
  • Loading branch information
grahamu authored Nov 16, 2017
2 parents c445da6 + 359b386 commit 654f2ae
Show file tree
Hide file tree
Showing 20 changed files with 417 additions and 213 deletions.
138 changes: 138 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
version: 2.0

common: &common
working_directory: ~/repo
steps:
- checkout
- restore_cache:
keys:
- v2-deps-{{ .Environment.CIRCLE_JOB }}-{{ checksum "setup.py" }}-{{ checksum "tox.ini" }}
- v2-deps-
- run:
name: install dependencies
command: pip install --user tox
- run:
name: run tox
command: ~/.local/bin/tox
- run:
name: upload coverage report
command: |
if [[ "$UPLOAD_COVERAGE" != 0 ]]; then
PATH=$HOME/.local/bin:$PATH
pip install --user codecov
coverage xml
~/.local/bin/codecov --required -X search gcov pycov -f coverage.xml --flags $CIRCLE_JOB
fi
- save_cache:
paths:
- .tox
- ~/.cache/pip
- ~/.local
- ./eggs
key: v2-deps-{{ .Environment.CIRCLE_JOB }}-{{ checksum "setup.py" }}-{{ checksum "tox.ini" }}

jobs:
lint:
<<: *common
docker:
- image: circleci/python:3.6.1
environment:
- TOXENV=checkqa
- UPLOAD_COVERAGE=0
py27dj18:
<<: *common
docker:
- image: circleci/python:2.7
environment:
TOXENV=py27-dj18
py27dj110:
<<: *common
docker:
- image: circleci/python:2.7
environment:
TOXENV=py27-dj110
py27dj111:
<<: *common
docker:
- image: circleci/python:2.7
environment:
TOXENV=py27-dj111
py34dj18:
<<: *common
docker:
- image: circleci/python:3.4
environment:
TOXENV=py34-dj18
py34dj110:
<<: *common
docker:
- image: circleci/python:3.4
environment:
TOXENV=py34-dj110
py34dj111:
<<: *common
docker:
- image: circleci/python:3.4
environment:
TOXENV=py34-dj111
py34dj20:
<<: *common
docker:
- image: circleci/python:3.4
environment:
TOXENV=py34-dj20
py35dj18:
<<: *common
docker:
- image: circleci/python:3.5
environment:
TOXENV=py35-dj18
py35dj110:
<<: *common
docker:
- image: circleci/python:3.5
environment:
TOXENV=py35-dj110
py35dj111:
<<: *common
docker:
- image: circleci/python:3.5
environment:
TOXENV=py35-dj111
py35dj20:
<<: *common
docker:
- image: circleci/python:3.5
environment:
TOXENV=py35-dj20
py36dj111:
<<: *common
docker:
- image: circleci/python:3.6
environment:
TOXENV=py36-dj111
py36dj20:
<<: *common
docker:
- image: circleci/python:3.6
environment:
TOXENV=py36-dj20

workflows:
version: 2
test:
jobs:
- lint
- py27dj18
- py27dj110
- py27dj111
- py34dj18
- py34dj110
- py34dj111
- py34dj20
- py35dj18
- py35dj110
- py35dj111
- py35dj20
- py36dj111
- py36dj20
51 changes: 41 additions & 10 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,13 +1,44 @@
build
dist
.coverage
.tox
MANIFEST
*.pyc
*.egg-info
*.egg
.DS_Store

# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]

# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
docs/_build/
htmlcov/
.eggs/
eggs/
lib/
lib64/
parts/
sdist/
var/
*.egg-info/
.installed.cfg
*.egg
*.eggs
.python-version
.pep8

# Pipfile
Pipfile
Pipfile.lock

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

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

# IDEs
.idea/
25 changes: 0 additions & 25 deletions .travis.yml

This file was deleted.

1 change: 1 addition & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ Thomas Schreiber
John Franey
Graham Ullrich
Ethan A Kent
Katherine “Kati” Michel
129 changes: 120 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,118 @@
![](http://pinaxproject.com/pinax-design/patches/pinax-documents.svg)

# Pinax Documents

[![](http://slack.pinaxproject.com/badge.svg)](http://slack.pinaxproject.com/)
[![](https://img.shields.io/travis/pinax/pinax-documents.svg)](https://travis-ci.org/pinax/pinax-documents)
[![](https://img.shields.io/coveralls/pinax/pinax-documents.svg)](https://coveralls.io/r/pinax/pinax-documents)

[![CircleCi](https://img.shields.io/circleci/project/github/pinax/pinax-documents.svg)](https://circleci.com/gh/pinax/pinax-documents)
[![Codecov](https://img.shields.io/codecov/c/github/pinax/pinax-documents.svg)](https://codecov.io/gh/pinax/pinax-documents)
[![](https://img.shields.io/pypi/dm/pinax-documents.svg)](https://pypi.python.org/pypi/pinax-documents/)
[![](https://img.shields.io/pypi/v/pinax-documents.svg)](https://pypi.python.org/pypi/pinax-documents/)
[![](https://img.shields.io/badge/license-MIT-blue.svg)](https://pypi.python.org/pypi/pinax-documents/)


## pinax-documents

`pinax-documents` is a well tested, documented, and proven document management app for collecting and sharing documents in folders.


## Table of Contents

* [Installation](#installation)
* [Filters](#filters)
* [Template tags](#template-tags)
* [Change Log](#change-log)
* [Pinax](#pinax)
* [Contribute](#contribute)
* [Contributors](#contributors)
* [Code of Conduct](#code-of-conduct)
* [Pinax Project Blog and Twitter](#pinax-project-blog-and-twitter)


## Installation

To install pinax-documents:

pip install pinax-documents

Add `pinax.documents` to your `INSTALLED_APPS` setting:

INSTALLED_APPS = (
...
"pinax.documents",
...
)

Add `pinax.documents.urls` to your project urlpatterns:

urlpatterns = [
...
url(r"^docs/", include("pinax.documents.urls", namespace="pinax_documents")),
...
]


## Template Tags

`{% load pinax_documents_tags %}`

### Filters

#### can_share

Returns True if `member` can share with `user`:

{{ member|can_share:user }}

#### readable_bytes

Display number of bytes using appropriate units.

{{ 73741824|readable_bytes }}

yields "70MB".


## Change Log

### 0.6.0

* Add Django 2.0 compatibility testing
* Drop Django 1.9 and Python 3.3 support
* Convert CI and coverage to CircleCi and CodeCov
* Add PyPi-compatible long description
* Move documentation to README.md

### 0.4.2

* Fix bug in document deletion where quota was not given back
* Made model strings for `Folder` and `Document` Python 3 compatible

### 0.4.1

* Updating documentation

### 0.4.0

* Moved template locations to be under `pinax/` [PR #9](https://github.com/pinax/pinax-documents/pull/9)
* Namespaced URLs [PR #10](https://github.com/pinax/pinax-documents/pull/10), [PR #16](https://github.com/pinax/pinax-documents/pull/16)
* Moved signal receiver to receivers.py [PR #11](https://github.com/pinax/pinax-documents/pull/11)
* Converted views to class based views [PR #12](https://github.com/pinax/pinax-documents/pull/12)
* Added hooksets [PR #15](https://github.com/pinax/pinax-documents/pull/15)
* Document deletion [PR #17](https://github.com/pinax/pinax-documents/pull/17)
* Folder deletion [PR #19](https://github.com/pinax/pinax-documents/pull/19)
* Disallow document name duplicates within same folder [PR #20](https://github.com/pinax/pinax-documents/pull/20)
* Disallow folder name duplicates within same parent [PR #20](https://github.com/pinax/pinax-documents/pull/20)

### 0.3.1

### 0.3.0

### 0.2.0

### 0.1


## Pinax

[Pinax](http://pinaxproject.com/pinax/) is an open-source platform built on the
Expand All @@ -16,13 +122,6 @@ starter project templates.
This app is part of the Pinax ecosystem and is designed for use both with and
independently of other Pinax apps.

## pinax-documents

``pinax-documents`` is a document management app, collecting and sharing documents in folders.

## Getting Started and Documentation

Follow steps outlined in [Pinax Documents Documentation](https://github.com/pinax/pinax-documents/blob/master/docs/index.md).

## Contribute

Expand All @@ -33,6 +132,18 @@ In case of any questions we recommend you [join our Pinax Slack team](http://sla
We also highly recommend reading our [Open Source and Self-Care blog post](http://blog.pinaxproject.com/2016/01/19/open-source-and-self-care/).


## Contributors

* [Graham Ullrich](https://github.com/grahamu)
* [Ethan A Kent](https://github.com/ethankent)
* [Patrick Altman](https://github.com/paltman)
* [Brian Rosner](https://github.com/brosner)
* [Anna Ossowski](https://github.com/ossanna16)
* [Thomas Schreiber](https://github.com/rizumu)
* [John Franey](https://github.com/johnfraney)
* [Katherine “Kati” Michel](https://github.com/KatherineMichel)


## Code of Conduct

In order to foster a kind, inclusive, and harassment-free community, the Pinax Project has a code of conduct, which can be found here http://pinaxproject.com/pinax/code_of_conduct/. We ask you to treat everyone as a smart human programmer that shares an interest in Python, Django, and Pinax with you.
Expand Down
Loading

0 comments on commit 654f2ae

Please sign in to comment.