Skip to content

Commit a17fea3

Browse files
chfwchfw
committed
📚 update project meta data
1 parent 1ddf73c commit a17fea3

14 files changed

+122
-34
lines changed

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,5 @@ With your PR, here is a check list:
44
- [ ] Has all code lines tested?
55
- [ ] Has `make format` been run?
66
- [ ] Please update CHANGELOG.yml(not CHANGELOG.rst)
7-
- [ ] Passes all Travis CI builds
87
- [ ] Has fair amount of documentation if your change is complex
98
- [ ] Agree on NEW BSD License for your contribution

‎.github/workflows/lint.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: lint
2+
3+
on: [push, pull_request]
4+
5+
jobs:
6+
lint:
7+
runs-on: ubuntu-latest
8+
name: lint code
9+
steps:
10+
- uses: actions/checkout@v2
11+
- name: Set up Python
12+
uses: actions/setup-python@v1
13+
with:
14+
python-version: 3.8
15+
- name: lint
16+
run: |
17+
pip --use-deprecated=legacy-resolver install flake8
18+
pip --use-deprecated=legacy-resolver install -r tests/requirements.txt
19+
flake8 --exclude=.moban.d,docs,setup.py --builtins=unicode,xrange,long .
20+
python setup.py checkdocs

‎.github/workflows/moban-update.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,22 @@ jobs:
88
- uses: actions/checkout@v2
99
with:
1010
ref: ${{ github.head_ref }}
11+
token: ${{ secrets.PAT }}
1112
- name: Set up Python
1213
uses: actions/setup-python@v1
1314
with:
1415
python-version: '3.7'
1516
- name: check changes
1617
run: |
18+
pip install markupsafe==2.0.1
1719
pip install moban gitfs2 pypifs moban-jinja2-github moban-ansible
1820
moban
1921
git status
2022
git diff --exit-code
2123
- name: Auto-commit
2224
if: failure()
23-
uses: docker://cdssnc/auto-commit-github-action
24-
env:
25-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
25+
uses: stefanzweifel/git-auto-commit-action@v4
2626
with:
27-
args: >-
27+
commit_message: >-
2828
This is an auto-commit, updating project meta data,
2929
such as changelog.rst, contributors.rst

‎.github/workflows/pythonpublish.yml

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,16 @@ on:
55
types: [created]
66

77
jobs:
8-
deploy:
8+
pypi-publish:
9+
name: upload release to PyPI
910
runs-on: ubuntu-latest
11+
# Specifying a GitHub environment is optional, but strongly encouraged
12+
environment: pypi
13+
permissions:
14+
# IMPORTANT: this permission is mandatory for trusted publishing
15+
id-token: write
1016
steps:
17+
# retrieve your distributions here
1118
- uses: actions/checkout@v1
1219
- name: Set up Python
1320
uses: actions/setup-python@v1
@@ -16,11 +23,9 @@ jobs:
1623
- name: Install dependencies
1724
run: |
1825
python -m pip install --upgrade pip
19-
pip install setuptools wheel twine
20-
- name: Build and publish
21-
env:
22-
TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
23-
TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
26+
pip install setuptools wheel
27+
- name: Build
2428
run: |
2529
python setup.py sdist bdist_wheel
26-
twine upload dist/*
30+
- name: Publish package distributions to PyPI
31+
uses: pypa/gh-action-pypi-publish@release/v1

‎.github/workflows/tests.yml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Run unit tests on Windows, Ubuntu and Mac
2+
3+
on: [push, pull_request]
4+
5+
jobs:
6+
7+
test:
8+
name: ${{ matrix.os }} / ${{ matrix.python_version }}
9+
runs-on: ${{ matrix.os }}-latest
10+
strategy:
11+
fail-fast: false
12+
matrix:
13+
os: [Ubuntu]
14+
python_version: ["3.9.16"]
15+
16+
steps:
17+
- uses: actions/checkout@v2
18+
- name: Set up Python
19+
uses: actions/setup-python@v5
20+
with:
21+
python-version: ${{ matrix.python_version }}
22+
architecture: x64
23+
24+
- name: install
25+
run: |
26+
pip --use-deprecated=legacy-resolver install -r requirements.txt
27+
pip --use-deprecated=legacy-resolver install -r tests/requirements.txt
28+
- name: test
29+
run: |
30+
pip freeze
31+
nosetests --verbosity=3 --with-coverage --cover-package django_excel --cover-package tests tests --with-doctest --doctest-extension=.rst README.rst docs/source django_excel
32+
- name: Upload coverage
33+
uses: codecov/codecov-action@v1
34+
with:
35+
name: ${{ matrix.os }} Python ${{ matrix.python-version }}

‎.readthedocs.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# .readthedocs.yml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
# Required
6+
version: 2
7+
8+
build:
9+
os: ubuntu-22.04
10+
tools:
11+
python: "3.12"
12+
13+
# Build documentation in the docs/ directory with Sphinx
14+
sphinx:
15+
configuration: docs/source/conf.py
16+
17+
# Optionally build your docs in additional formats such as PDF
18+
formats:
19+
- pdf
20+
21+
python:
22+
install:
23+
- requirements: docs/requirements.txt

‎CHANGELOG.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,15 @@
11
Change log
22
================================================================================
33

4+
0.0.12 - 18.08.2022
5+
--------------------------------------------------------------------------------
6+
7+
**Change:**
8+
9+
#. Support for django 2.0.x
10+
#. Tested against django 4.1
11+
#. Change xlrd version <=1.2.0
12+
413
0.0.11 - tbd
514
--------------------------------------------------------------------------------
615

‎CONTRIBUTORS.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11

22

3-
3 contributors
3+
4 contributors
44
================================================================================
55

66
In alphabetical order:
77

88
* `Minh-Long Do <https://github.com/minhlongdo>`_
99
* `oon arfiandwi <https://github.com/oonid>`_
1010
* `Utpal Brahma <https://github.com/thebrahma>`_
11+
* `yeop <https://github.com/yeop-sang>`_

‎LICENSE

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright (c) 2015-2020 by Onni Software Ltd. and its contributors
1+
Copyright (c) 2015-2022 by Onni Software Ltd. and its contributors
22
All rights reserved.
33

44
Redistribution and use in source and binary forms of the software as well
@@ -13,7 +13,7 @@ that the following conditions are met:
1313
and/or other materials provided with the distribution.
1414

1515
* Neither the name of 'django-excel' nor the names of the contributors
16-
may not be used to endorse or promote products derived from this software
16+
may be used to endorse or promote products derived from this software
1717
without specific prior written permission.
1818

1919
THIS SOFTWARE AND DOCUMENTATION IS PROVIDED BY THE COPYRIGHT HOLDERS AND

‎README.rst

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,14 @@ django-excel - Let you focus on data, instead of file formats
88
.. image:: https://raw.githubusercontent.com/pyexcel/pyexcel-mobans/master/images/awesome-badge.svg
99
:target: https://awesome-python.com/#specific-formats-processing
1010

11-
.. image:: https://travis-ci.org/pyexcel-webwares/django-excel.svg?branch=master
12-
:target: http://travis-ci.org/pyexcel-webwares/django-excel
13-
1411
.. image:: https://codecov.io/gh/pyexcel-webwares/django-excel/branch/master/graph/badge.svg
1512
:target: https://codecov.io/gh/pyexcel-webwares/django-excel
1613

1714
.. image:: https://badge.fury.io/py/django-excel.svg
1815
:target: https://pypi.org/project/django-excel
1916

2017

21-
.. image:: https://pepy.tech/badge/django-excel/month
22-
:target: https://pepy.tech/project/django-excel
18+
2319

2420

2521
.. image:: https://img.shields.io/gitter/room/gitterHQ/gitter.svg
@@ -107,7 +103,7 @@ The highlighted features are:
107103
======================== ======================= =================
108104
Package name Supported file formats Dependencies
109105
======================== ======================= =================
110-
`pyexcel-io`_ csv, csvz [#f1]_, tsv,
106+
`pyexcel-io`_ csv, csvz [#f1]_, tsv, csvz,tsvz readers depends on `chardet`
111107
tsvz [#f2]_
112108
`pyexcel-xls`_ xls, xlsx(read only), `xlrd`_,
113109
xlsm(read only) `xlwt`_
@@ -136,9 +132,9 @@ The highlighted features are:
136132
Plugin shopping guide
137133
------------------------
138134

139-
Since 2020, all pyexcel-io plugins have dropped the support for python version
140-
lower than 3.6. If you want to use any python verions, please use pyexcel-io
141-
and its plugins version lower than 0.6.0.
135+
Since 2020, all pyexcel-io plugins have dropped the support for python versions
136+
which are lower than 3.6. If you want to use any of those Python versions, please use pyexcel-io
137+
and its plugins versions that are lower than 0.6.0.
142138

143139

144140
Except csv files, xls, xlsx and ods files are a zip of a folder containing a lot of
@@ -334,7 +330,7 @@ Then install relevant development requirements:
334330
#. pip install -r tests/requirements.txt
335331

336332
Once you have finished your changes, please provide test case(s), relevant documentation
337-
and update CHANGELOG.rst.
333+
and update changelog.yml
338334

339335
.. note::
340336

@@ -353,7 +349,7 @@ On Linux/Unix systems, please launch your tests like this::
353349

354350
$ make
355351

356-
On Windows systems, please issue this command::
352+
On Windows, please issue this command::
357353

358354
> test.bat
359355

@@ -365,7 +361,7 @@ Please run::
365361

366362
$ make format
367363

368-
so as to beautify your code otherwise travis-ci may fail your unit test.
364+
so as to beautify your code otherwise your build may fail your unit test.
369365

370366

371367

‎docs/source/index.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ The highlighted features are:
6060
======================== ======================= =================
6161
Package name Supported file formats Dependencies
6262
======================== ======================= =================
63-
`pyexcel-io`_ csv, csvz [#f1]_, tsv,
63+
`pyexcel-io`_ csv, csvz [#f1]_, tsv, csvz,tsvz readers depends on `chardet`
6464
tsvz [#f2]_
6565
`pyexcel-xls`_ xls, xlsx(read only), `xlrd`_,
6666
xlsm(read only) `xlwt`_
@@ -89,9 +89,9 @@ The highlighted features are:
8989
Plugin shopping guide
9090
------------------------
9191

92-
Since 2020, all pyexcel-io plugins have dropped the support for python version
93-
lower than 3.6. If you want to use any python verions, please use pyexcel-io
94-
and its plugins version lower than 0.6.0.
92+
Since 2020, all pyexcel-io plugins have dropped the support for python versions
93+
which are lower than 3.6. If you want to use any of those Python versions, please use pyexcel-io
94+
and its plugins versions that are lower than 0.6.0.
9595

9696

9797
Except csv files, xls, xlsx and ods files are a zip of a folder containing a lot of

‎requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
pyexcel>=0.5.7
22
pyexcel-webio>=0.1.2
3-
Django>=2.0
3+
Django>=1.6.1

‎setup.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
)
4242
URL = "https://github.com/pyexcel-webwares/django-excel"
4343
DOWNLOAD_URL = "%s/archive/0.0.10.tar.gz" % URL
44-
FILES = ["README.rst", "CHANGELOG.rst"]
44+
FILES = ["README.rst", "CONTRIBUTORS.rst", "CHANGELOG.rst"]
4545
KEYWORDS = [
4646
"python",
4747
"API",
@@ -75,6 +75,7 @@
7575
'Programming Language :: Python :: 3.3',
7676
'Programming Language :: Python :: 3.4',
7777
'Programming Language :: Python :: 3.5'
78+
7879
]
7980

8081

‎tests/requirements.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
xlrd<=1.2.0
21
nose
32
mock;python_version<"3"
43
codecov

0 commit comments

Comments
 (0)