Skip to content

Commit 98d3ff8

Browse files
ericmjlericmjl
authored
[INF/DOC] Clean up repository and add docstrings to add_columns.py (pyjanitor-devs#971)
* Remove original docs repo * Sneak in first docstring MWE. * Removed unnecessary whitespace. * Remove unnecessary check-autodoc.py script * Add minimal working examples to add_columns.py * Configured pytest to work with doctest now * Add docstring-based examples. * Pin pandas version to trigger a rebuild on CI. * Remove pyspark from docs temporarily. * Pin pyspark to 3.1.2 to see if it reverts build errors. * Comment out pyspark from navigation. * Get rid of codecov.
1 parent 9c5ff2c commit 98d3ff8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+124
-1652
lines changed

‎.github/workflows/codecov.yml

+67-67
Original file line numberDiff line numberDiff line change
@@ -1,82 +1,82 @@
1-
# This Action ensures that code coverage is always uploaded to codecov
2-
# whenever a new commit is made to the dev branch.
3-
name: Upload test coverage to codecov
1+
# # This Action ensures that code coverage is always uploaded to codecov
2+
# # whenever a new commit is made to the dev branch.
3+
# name: Upload test coverage to codecov
44

5-
on:
6-
push:
7-
branch:
8-
dev
5+
# on:
6+
# push:
7+
# branch:
8+
# dev
99

10-
jobs:
11-
build-environment:
12-
name: Build environment
13-
runs-on: ubuntu-latest
10+
# jobs:
11+
# build-environment:
12+
# name: Build environment
13+
# runs-on: ubuntu-latest
1414

15-
steps:
16-
- name: Checkout repository
17-
uses: actions/checkout@v2
15+
# steps:
16+
# - name: Checkout repository
17+
# uses: actions/checkout@v2
1818

19-
# See: https://github.com/marketplace/actions/setup-conda
20-
- name: Setup anaconda
21-
uses: s-weigand/setup-conda@v1
22-
with:
23-
conda-channels: "conda-forge"
19+
# # See: https://github.com/marketplace/actions/setup-conda
20+
# - name: Setup anaconda
21+
# uses: s-weigand/setup-conda@v1
22+
# with:
23+
# conda-channels: "conda-forge"
2424

25-
# Build cache of environment
26-
- name: Cache conda environment
27-
id: cache-environment
28-
uses: actions/cache@v2
29-
# Conda environment build step depends on two files,
30-
# so we ensure that the hash key contains both their hashes.
31-
with:
32-
path: |
33-
pyjanitor-dev.tar.gz
34-
key: ${{ runner.os }}-env.${{ hashFiles('environment-dev.yml') }}
25+
# # Build cache of environment
26+
# - name: Cache conda environment
27+
# id: cache-environment
28+
# uses: actions/cache@v2
29+
# # Conda environment build step depends on two files,
30+
# # so we ensure that the hash key contains both their hashes.
31+
# with:
32+
# path: |
33+
# pyjanitor-dev.tar.gz
34+
# key: ${{ runner.os }}-env.${{ hashFiles('environment-dev.yml') }}
3535

36-
- name: Build environment
37-
if: steps.cache-environment.outputs.cache-hit != 'true'
38-
run: bash ./scripts/ci/build_environment.sh
36+
# - name: Build environment
37+
# if: steps.cache-environment.outputs.cache-hit != 'true'
38+
# run: bash ./scripts/ci/build_environment.sh
3939

40-
- name: Install conda-pack
41-
if: steps.cache-environment.outputs.cache-hit != 'true'
42-
run: conda install -c conda-forge conda-pack
40+
# - name: Install conda-pack
41+
# if: steps.cache-environment.outputs.cache-hit != 'true'
42+
# run: conda install -c conda-forge conda-pack
4343

44-
- name: Run conda-pack
45-
if: steps.cache-environment.outputs.cache-hit != 'true'
46-
run: conda pack -n pyjanitor-dev -o pyjanitor-dev.tar.gz
44+
# - name: Run conda-pack
45+
# if: steps.cache-environment.outputs.cache-hit != 'true'
46+
# run: conda pack -n pyjanitor-dev -o pyjanitor-dev.tar.gz
4747

48-
# See: https://github.com/actions/upload-artifact
49-
- name: Upload environment
50-
uses: actions/upload-artifact@v2
51-
with:
52-
name: pyjanitor-dev-tarball
53-
path: pyjanitor-dev.tar.gz
48+
# # See: https://github.com/actions/upload-artifact
49+
# - name: Upload environment
50+
# uses: actions/upload-artifact@v2
51+
# with:
52+
# name: pyjanitor-dev-tarball
53+
# path: pyjanitor-dev.tar.gz
5454

55-
unit-tests:
56-
name: Run unit tests
57-
runs-on: ubuntu-latest
58-
needs: build-environment
55+
# unit-tests:
56+
# name: Run unit tests
57+
# runs-on: ubuntu-latest
58+
# needs: build-environment
5959

60-
steps:
61-
- name: Checkout repository
62-
uses: actions/checkout@v2
60+
# steps:
61+
# - name: Checkout repository
62+
# uses: actions/checkout@v2
6363

64-
# https://github.com/actions/download-artifact
65-
- name: Download environment tarball
66-
uses: actions/download-artifact@v2
67-
with:
68-
name: pyjanitor-dev-tarball
64+
# # https://github.com/actions/download-artifact
65+
# - name: Download environment tarball
66+
# uses: actions/download-artifact@v2
67+
# with:
68+
# name: pyjanitor-dev-tarball
6969

70-
- name: Unpack environment and activate it
71-
run: bash scripts/ci/unpack_environment.sh
70+
# - name: Unpack environment and activate it
71+
# run: bash scripts/ci/unpack_environment.sh
7272

73-
- name: Run tests
74-
run: |
75-
source /tmp/pyjanitor-dev_env/bin/activate
76-
python -m pip install -e .
77-
pytest
73+
# - name: Run tests
74+
# run: |
75+
# source /tmp/pyjanitor-dev_env/bin/activate
76+
# python -m pip install -e .
77+
# pytest
7878

79-
- name: Upload code coverage
80-
run: |
81-
source /tmp/pyjanitor-dev_env/bin/activate
82-
bash <(curl -s https://codecov.io/bash)
79+
# - name: Upload code coverage
80+
# run: |
81+
# source /tmp/pyjanitor-dev_env/bin/activate
82+
# bash <(curl -s https://codecov.io/bash)

‎.github/workflows/tests.yml

+6-6
Original file line numberDiff line numberDiff line change
@@ -71,12 +71,12 @@ jobs:
7171
python -m pip install -e .
7272
make test
7373
74-
# https://github.com/codecov/codecov-action
75-
- name: Upload code coverage
76-
uses: codecov/codecov-action@v2
77-
with:
78-
fail_ci_if_error: true # optional (default = false)
79-
verbose: true # optional (default = false)
74+
# # https://github.com/codecov/codecov-action
75+
# - name: Upload code coverage
76+
# uses: codecov/codecov-action@v2
77+
# with:
78+
# fail_ci_if_error: true # optional (default = false)
79+
# verbose: true # optional (default = false)
8080

8181
jupyter-notebook:
8282
name: Execute all Jupyter notebooks

0 commit comments

Comments
 (0)