mirror of
https://github.com/louisleroy5/trnslator.git
synced 2024-11-14 16:20:31 -05:00
Merge branch 'develop' into feature/Requirements
This commit is contained in:
commit
33db7c6dcf
2
.coveragerc
Normal file
2
.coveragerc
Normal file
|
@ -0,0 +1,2 @@
|
|||
[run]
|
||||
omit = tests/*
|
29
.readthedocs.yml
Normal file
29
.readthedocs.yml
Normal file
|
@ -0,0 +1,29 @@
|
|||
# .readthedocs.yml
|
||||
# Read the Docs configuration file
|
||||
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
|
||||
|
||||
# Required
|
||||
version: 2
|
||||
|
||||
# Build documentation in the docs/ directory with Sphinx
|
||||
sphinx:
|
||||
configuration: docs/conf.py
|
||||
|
||||
# Build documentation with MkDocs
|
||||
#mkdocs:
|
||||
# configuration: mkdocs.yml
|
||||
|
||||
# Optionally build your docs in additional formats such as PDF and ePub
|
||||
formats:
|
||||
- epub
|
||||
- pdf
|
||||
|
||||
# Optionally set the version of Python and requirements required to build your docs
|
||||
python:
|
||||
version: 3.7
|
||||
install:
|
||||
- requirements: requirements.txt
|
||||
- method: pip
|
||||
path: .
|
||||
extra_requirements:
|
||||
- dev
|
17
CONTRIBUTING.md
Normal file
17
CONTRIBUTING.md
Normal file
|
@ -0,0 +1,17 @@
|
|||
Thank you for using *translater* and for considering contributing to it!
|
||||
|
||||
#### For errors in the code:
|
||||
|
||||
- read the error message and [documentation](https://translater.readthedocs.io/);
|
||||
- search through the [open issues](https://github.com/louisleroy5/translater/issues?q=is%3Aopen+is%3Aissue) and [closed issues](https://github.com/louisleroy5/translater/issues?q=is%3Aissue+is%3Aclosed) first;
|
||||
- if the problem is with a dependency of this project, open an issue on the dependency's repo;
|
||||
- if the problem is with *translater* and you can fix it simply, please submit a [PR](https://github.com/louisleroy5/translater/pulls);
|
||||
- if the problem persists, please open an issue in the [issue tracker](https://github.com/louisleroy5/translater/issues) including a minimal working example to reproduce the problem.
|
||||
|
||||
#### If you have a feature proposal or want to contribute
|
||||
|
||||
- post your proposal on the [issue tracker](https://github.com/louisleroy5/translater/issues) so we can review it together (some proposals may not be a good fit for the project);
|
||||
- fork the repo, make your change (adhering to translater's existing coding format, commenting, and docstring styles);
|
||||
- [test it](https://github.com/louisleroy5/translater/tree/develop/tests);
|
||||
- format your code using [black](https://black.readthedocs.io/en/stable/) and submit a [PR](https://github.com/louisleroy5/translater/pulls);
|
||||
- respond to code review.
|
20
Makefile
Normal file
20
Makefile
Normal file
|
@ -0,0 +1,20 @@
|
|||
# Minimal makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line.
|
||||
SPHINXOPTS =
|
||||
SPHINXBUILD = sphinx-build
|
||||
SPHINXPROJ = translater
|
||||
SOURCEDIR = ./docs
|
||||
BUILDDIR = _build
|
||||
|
||||
# Put it first so that "make" without argument is like "make help".
|
||||
help:
|
||||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
|
||||
.PHONY: help Makefile
|
||||
|
||||
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||
%: Makefile
|
||||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
36
make.bat
Normal file
36
make.bat
Normal file
|
@ -0,0 +1,36 @@
|
|||
@ECHO OFF
|
||||
|
||||
pushd %~dp0
|
||||
|
||||
REM Command file for Sphinx documentation
|
||||
|
||||
if "%SPHINXBUILD%" == "" (
|
||||
set SPHINXBUILD=sphinx-build
|
||||
)
|
||||
set SOURCEDIR=./docs
|
||||
set BUILDDIR=_build
|
||||
set SPHINXPROJ=translater
|
||||
|
||||
if "%1" == "" goto help
|
||||
|
||||
%SPHINXBUILD% >NUL 2>NUL
|
||||
if errorlevel 9009 (
|
||||
echo.
|
||||
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
|
||||
echo.installed, then set the SPHINXBUILD environment variable to point
|
||||
echo.to the full path of the 'sphinx-build' executable. Alternatively you
|
||||
echo.may add the Sphinx directory to PATH.
|
||||
echo.
|
||||
echo.If you don't have Sphinx installed, grab it from
|
||||
echo.http://sphinx-doc.org/
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
|
||||
goto end
|
||||
|
||||
:help
|
||||
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
|
||||
|
||||
:end
|
||||
popd
|
52
meta.yaml
Normal file
52
meta.yaml
Normal file
|
@ -0,0 +1,52 @@
|
|||
{% set name = "translater" %}
|
||||
{% set version = "1.0.1" %}
|
||||
{% set sha256 = "3e97f799769469412b12b8d71cc2342d0c93c9f6ea4ca36366c415eef9fbe344" %}
|
||||
|
||||
package:
|
||||
name: {{ name }}
|
||||
version: {{ version }}
|
||||
|
||||
#source:
|
||||
# fn: {{ name }}-{{ version }}.tar.gz
|
||||
# url: https://pypi.io/packages/source/{{ name[0] }}/{{ name }}/{{ name }}-{{ version }}.tar.gz
|
||||
# sha256: {{ sha256 }}
|
||||
|
||||
build:
|
||||
noarch: python
|
||||
number: 0
|
||||
script: python -m pip install --no-deps --ignore-installed .
|
||||
|
||||
requirements:
|
||||
build:
|
||||
- python
|
||||
- pip
|
||||
run:
|
||||
- python
|
||||
- requests
|
||||
- numpy
|
||||
- pandas
|
||||
- matplotlib
|
||||
- shapely
|
||||
- descartes
|
||||
- geopy
|
||||
- rtree
|
||||
- folium
|
||||
|
||||
test:
|
||||
imports:
|
||||
- translater
|
||||
|
||||
about:
|
||||
home: https://github.com/louisleroy5/translater
|
||||
license: MIT
|
||||
license_family: MIT
|
||||
license_file: LICENSE.txt
|
||||
summary: 'Convert IDF file (EnergyPlus) to BUI file (TRNBuild)'
|
||||
description: |
|
||||
translater is a Python package.
|
||||
doc_url: https://translater.readthedocs.io
|
||||
dev_url: https://github.com/louisleroy5/translater
|
||||
|
||||
extra:
|
||||
recipe-maintainers:
|
||||
- louisleroy5
|
Loading…
Reference in New Issue
Block a user