Skip to content

Commit d7d946b

Browse files
chfwchfw
committed
📚 update project meta data
1 parent b48d772 commit d7d946b

File tree

7 files changed

+91
-38
lines changed

7 files changed

+91
-38
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.11
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: 6 additions & 6 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:
14-
python-version: '3.7'
15+
python-version: '3.11'
1516
- name: check changes
1617
run: |
17-
pip install moban gitfs2 pypifs moban-jinja2-github moban-ansible
18+
pip install markupsafe==2.0.1
19+
pip install ruamel.yaml 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: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
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+
pip --use-deprecated=legacy-resolver install -r rnd_requirements.txt
29+
- name: test
30+
run: |
31+
pip freeze
32+
nosetests --verbosity=3 --with-coverage --cover-package pyexcel_odsw --cover-package tests tests --with-doctest --doctest-extension=.rst README.rst docs/source pyexcel_odsw
33+
- name: Upload coverage
34+
uses: codecov/codecov-action@v1
35+
with:
36+
name: ${{ matrix.os }} Python ${{ matrix.python-version }}

‎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-2025 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 'pyexcel-odsw' 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: 15 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,14 @@ pyexcel-odsw - 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/pyexcel-odsw.svg?branch=master
12-
:target: http://travis-ci.org/pyexcel/pyexcel-odsw
13-
1411
.. image:: https://codecov.io/gh/pyexcel/pyexcel-odsw/branch/master/graph/badge.svg
1512
:target: https://codecov.io/gh/pyexcel/pyexcel-odsw
1613

1714

1815

1916

2017

18+
2119
.. image:: https://img.shields.io/gitter/room/gitterHQ/gitter.svg
2220
:target: https://gitter.im/pyexcel/Lobby
2321

@@ -32,19 +30,11 @@ pyexcel-odsw - Let you focus on data, instead of file formats
3230
Support the project
3331
================================================================================
3432

35-
If your company has embedded pyexcel and its components into a revenue generating
36-
product, please support me on github, `patreon <https://www.patreon.com/bePatron?u=5537627>`_
37-
or `bounty source <https://salt.bountysource.com/teams/chfw-pyexcel>`_ to maintain
38-
the project and develop it further.
39-
40-
If you are an individual, you are welcome to support me too and for however long
41-
you feel like. As my backer, you will receive
42-
`early access to pyexcel related contents <https://www.patreon.com/pyexcel/posts>`_.
43-
44-
And your issues will get prioritized if you would like to become my patreon as `pyexcel pro user`.
45-
46-
With your financial support, I will be able to invest
47-
a little bit more time in coding, documentation and writing interesting posts.
33+
If your company uses pyexcel and its components in a revenue-generating product,
34+
please consider supporting the project on GitHub or
35+
`Patreon <https://www.patreon.com/bePatron?u=5537627>`_. Your financial
36+
support will enable me to dedicate more time to coding, improving documentation,
37+
and creating engaging content.
4838

4939

5040

@@ -85,26 +75,29 @@ Then install relevant development requirements:
8575
#. pip install -r tests/requirements.txt
8676

8777
Once you have finished your changes, please provide test case(s), relevant documentation
88-
and update CHANGELOG.rst.
78+
and update changelog.yml
8979

9080
.. note::
9181

9282
As to rnd_requirements.txt, usually, it is created when a dependent
93-
library is not released. Once the dependecy is installed
83+
library is not released. Once the dependency is installed
9484
(will be released), the future
9585
version of the dependency in the requirements.txt will be valid.
9686

9787

9888
How to test your contribution
99-
------------------------------
89+
--------------------------------------------------------------------------------
10090

101-
Although `nose` and `doctest` are both used in code testing, it is adviable that unit tests are put in tests. `doctest` is incorporated only to make sure the code examples in documentation remain valid across different development releases.
91+
Although `nose` and `doctest` are both used in code testing, it is advisable
92+
that unit tests are put in tests. `doctest` is incorporated only to make sure
93+
the code examples in documentation remain valid across different development
94+
releases.
10295

10396
On Linux/Unix systems, please launch your tests like this::
10497

10598
$ make
10699

107-
On Windows systems, please issue this command::
100+
On Windows, please issue this command::
108101

109102
> test.bat
110103

@@ -116,7 +109,7 @@ Please run::
116109

117110
$ make format
118111

119-
so as to beautify your code otherwise travis-ci may fail your unit test.
112+
so as to beautify your code otherwise your build may fail your unit test.
120113

121114

122115

0 commit comments

Comments
 (0)