Skip to content

Commit 8508b6e

Browse files
astropenguinastropenguin
authored
#161 Merge pull request from astropenguin/astropenguin/issue160
Release v1.2.0
2 parents 2a2e84b + 9241f2b commit 8508b6e

File tree

6 files changed

+55
-151
lines changed

6 files changed

+55
-151
lines changed

‎.devcontainer/devcontainer.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
"name": "xarray-dataclasses",
33
"build": {
44
"context": "..",
5-
"dockerfile": "Dockerfile",
5+
"dockerfile": "Dockerfile"
66
},
77
"postCreateCommand": "poetry install",
88
"extensions": [
99
"github.vscode-pull-request-github",
1010
"mhutchie.git-graph",
1111
"ms-python.python",
1212
"streetsidesoftware.code-spell-checker",
13-
"tamasfe.even-better-toml",
13+
"tamasfe.even-better-toml"
1414
],
1515
"settings": {
1616
"files.insertFinalNewline": true,
@@ -20,7 +20,7 @@
2020
"[python]": {
2121
"editor.formatOnSave": true,
2222
"editor.insertSpaces": true,
23-
"editor.tabSize": 4,
24-
},
25-
},
23+
"editor.tabSize": 4
24+
}
25+
}
2626
}

‎.gitignore

Lines changed: 29 additions & 124 deletions
Original file line numberDiff line numberDiff line change
@@ -1,125 +1,5 @@
1-
# Created by https://www.toptal.com/developers/gitignore/api/node,python
2-
# Edit at https://www.toptal.com/developers/gitignore?templates=node,python
3-
4-
### Node ###
5-
# Logs
6-
logs
7-
*.log
8-
npm-debug.log*
9-
yarn-debug.log*
10-
yarn-error.log*
11-
lerna-debug.log*
12-
.pnpm-debug.log*
13-
14-
# Diagnostic reports (https://nodejs.org/api/report.html)
15-
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
16-
17-
# Runtime data
18-
pids
19-
*.pid
20-
*.seed
21-
*.pid.lock
22-
23-
# Directory for instrumented libs generated by jscoverage/JSCover
24-
lib-cov
25-
26-
# Coverage directory used by tools like istanbul
27-
coverage
28-
*.lcov
29-
30-
# nyc test coverage
31-
.nyc_output
32-
33-
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
34-
.grunt
35-
36-
# Bower dependency directory (https://bower.io/)
37-
bower_components
38-
39-
# node-waf configuration
40-
.lock-wscript
41-
42-
# Compiled binary addons (https://nodejs.org/api/addons.html)
43-
build/Release
44-
45-
# Dependency directories
46-
node_modules/
47-
jspm_packages/
48-
49-
# Snowpack dependency directory (https://snowpack.dev/)
50-
web_modules/
51-
52-
# TypeScript cache
53-
*.tsbuildinfo
54-
55-
# Optional npm cache directory
56-
.npm
57-
58-
# Optional eslint cache
59-
.eslintcache
60-
61-
# Microbundle cache
62-
.rpt2_cache/
63-
.rts2_cache_cjs/
64-
.rts2_cache_es/
65-
.rts2_cache_umd/
66-
67-
# Optional REPL history
68-
.node_repl_history
69-
70-
# Output of 'npm pack'
71-
*.tgz
72-
73-
# Yarn Integrity file
74-
.yarn-integrity
75-
76-
# dotenv environment variables file
77-
.env
78-
.env.test
79-
.env.production
80-
81-
# parcel-bundler cache (https://parceljs.org/)
82-
.cache
83-
.parcel-cache
84-
85-
# Next.js build output
86-
.next
87-
out
88-
89-
# Nuxt.js build / generate output
90-
.nuxt
91-
dist
92-
93-
# Gatsby files
94-
.cache/
95-
# Comment in the public line in if your project uses Gatsby and not Next.js
96-
# https://nextjs.org/blog/next-9-1#public-directory-support
97-
# public
98-
99-
# vuepress build output
100-
.vuepress/dist
101-
102-
# Serverless directories
103-
.serverless/
104-
105-
# FuseBox cache
106-
.fusebox/
107-
108-
# DynamoDB Local files
109-
.dynamodb/
110-
111-
# TernJS port file
112-
.tern-port
113-
114-
# Stores VSCode versions used for testing VSCode extensions
115-
.vscode-test
116-
117-
# yarn v2
118-
.yarn/cache
119-
.yarn/unplugged
120-
.yarn/build-state.yml
121-
.yarn/install-state.gz
122-
.pnp.*
1+
# Created by https://www.toptal.com/developers/gitignore/api/python
2+
# Edit at https://www.toptal.com/developers/gitignore?templates=python
1233

1244
### Python ###
1255
# Byte-compiled / optimized / DLL files
@@ -166,6 +46,7 @@ htmlcov/
16646
.nox/
16747
.coverage
16848
.coverage.*
49+
.cache
16950
nosetests.xml
17051
coverage.xml
17152
*.cover
@@ -179,6 +60,7 @@ cover/
17960
*.pot
18061

18162
# Django stuff:
63+
*.log
18264
local_settings.py
18365
db.sqlite3
18466
db.sqlite3-journal
@@ -217,7 +99,22 @@ ipython_config.py
21799
# install all needed dependencies.
218100
#Pipfile.lock
219101

220-
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
102+
# poetry
103+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
104+
# This is especially recommended for binary packages to ensure reproducibility, and is more
105+
# commonly ignored for libraries.
106+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
107+
#poetry.lock
108+
109+
# pdm
110+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
111+
#pdm.lock
112+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
113+
# in version control.
114+
# https://pdm.fming.dev/#use-with-ide
115+
.pdm.toml
116+
117+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
221118
__pypackages__/
222119

223120
# Celery stuff
@@ -228,6 +125,7 @@ celerybeat.pid
228125
*.sage.py
229126

230127
# Environments
128+
.env
231129
.venv
232130
env/
233131
venv/
@@ -259,4 +157,11 @@ dmypy.json
259157
# Cython debug symbols
260158
cython_debug/
261159

262-
# End of https://www.toptal.com/developers/gitignore/api/node,python
160+
# PyCharm
161+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
162+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
163+
# and can be added to the global gitignore or merged into this file. For a more nuclear
164+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
165+
#.idea/
166+
167+
# End of https://www.toptal.com/developers/gitignore/api/python

‎README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# xarray-dataclasses
22

3-
[![PyPI](https://img.shields.io/pypi/v/xarray-dataclasses.svg?label=PyPI&style=flat-square)](https://pypi.org/project/xarray-dataclasses/)
4-
[![Python](https://img.shields.io/pypi/pyversions/xarray-dataclasses.svg?label=Python&color=yellow&style=flat-square)](https://pypi.org/project/xarray-dataclasses/)
5-
[![Test](https://img.shields.io/github/workflow/status/astropenguin/xarray-dataclasses/Tests?logo=github&label=Test&style=flat-square)](https://github.com/astropenguin/xarray-dataclasses/actions)
6-
[![License](https://img.shields.io/badge/license-MIT-blue.svg?label=License&style=flat-square)](LICENSE)
7-
[![DOI](https://img.shields.io/badge/DOI-10.5281/zenodo.4624819-blue?style=flat-square)](https://doi.org/10.5281/zenodo.4624819)
3+
[![Release](https://img.shields.io/pypi/v/xarray-dataclasses?label=Release&color=cornflowerblue&style=flat-square)](https://pypi.org/project/xarray-dataclasses/)
4+
[![Python](https://img.shields.io/pypi/pyversions/xarray-dataclasses?label=Python&color=cornflowerblue&style=flat-square)](https://pypi.org/project/xarray-dataclasses/)
5+
![Downloads](https://img.shields.io/pypi/dm/xarray-dataclasses?label=Downloads&color=cornflowerblue&style=flat-square)
6+
[![DOI](https://img.shields.io/badge/DOI-10.5281/zenodo.4624819-cornflowerblue?style=flat-square)](https://doi.org/10.5281/zenodo.4624819)
7+
[![Tests](https://img.shields.io/github/workflow/status/astropenguin/xarray-dataclasses/Tests?label=Tests&style=flat-square)](https://github.com/astropenguin/xarray-dataclasses/actions)
88

99
xarray extension for typed DataArray and Dataset creation
1010

‎docs/conf.py

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,30 @@
1-
# Project information
1+
# project information
22
author = "Akio Taniguchi"
33
copyright = "2020-2022 Akio Taniguchi"
44

55

6-
# General configuration
6+
# general configuration
7+
add_module_names = False
8+
autodoc_typehints = "both"
9+
autodoc_typehints_format = "short"
10+
exclude_patterns = [
11+
"_build",
12+
"Thumbs.db",
13+
".DS_Store",
14+
]
715
extensions = [
816
"myst_parser",
917
"sphinx.ext.autodoc",
10-
"sphinx.ext.viewcode",
11-
"sphinx.ext.napoleon",
1218
"sphinx.ext.autosummary",
19+
"sphinx.ext.napoleon",
20+
"sphinx.ext.viewcode",
1321
]
1422
templates_path = ["_templates"]
15-
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
1623

1724

18-
# Options for HTML output
19-
html_static_path = ["_static"]
25+
# options for HTML output
2026
html_logo = "_static/logo.svg"
27+
html_static_path = ["_static"]
2128
html_theme = "pydata_sphinx_theme"
2229
html_theme_options = {
2330
"github_url": "https://github.com/astropenguin/xarray-dataclasses/",

‎pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "xarray-dataclasses"
3-
version = "1.1.0"
3+
version = "1.2.0"
44
description = "xarray extension for typed DataArray and Dataset creation"
55
authors = ["Akio Taniguchi <[email protected]>"]
66
keywords = ["xarray", "dataclass", "dataarray", "dataset", "typing"]

‎xarray_dataclasses/__init__.py

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,8 @@
11
# type: ignore
2-
__version__ = "1.1.0"
2+
__version__ = "1.2.0"
33

44

55
# submodules
6-
from . import dataarray
7-
from . import dataset
8-
from . import datamodel
9-
from . import dataoptions
10-
from . import typing
11-
12-
13-
# aliases
146
from .dataarray import *
157
from .dataset import *
168
from .datamodel import *

0 commit comments

Comments
 (0)