diff --git a/.cspell.json b/.cspell.json index 398795018a..f74492eb55 100644 --- a/.cspell.json +++ b/.cspell.json @@ -25,6 +25,7 @@ "auditlog", "auth", "autogenerated", + "automodule", "aws", "AWS", "backend", @@ -54,6 +55,7 @@ "casted", "cb", "CEJST", + "celerybeat", "cfg", "changelog", "checkbox", diff --git a/.gitignore b/.gitignore index 166547d8dc..a670635509 100644 --- a/.gitignore +++ b/.gitignore @@ -1,17 +1,18 @@ -.DS_Store .cache +.coverage +.cspell.txt +.DS_Store .env .hypothesis .idea .project .pydevproject .python-version -.coverage .vscode coverage.protractor.json -.vscode *~ *~$* +*.ipynb *.pyc *.swp *.swo @@ -25,7 +26,6 @@ pkgs/newrelic-1\.6\.0\.13\.tar\.gz chromedriver.log ipython_input_log_history .ipython_input_log_history -*.ipynb **/ipython_input_log_history web_root/csvs/* web_root/uploads/* diff --git a/bin/protractor_start_server.sh b/bin/protractor_start_server.sh index c576cb64d4..3c25e1fb7e 100755 --- a/bin/protractor_start_server.sh +++ b/bin/protractor_start_server.sh @@ -18,8 +18,6 @@ echo "run e2e tests" ./node_modules/protractor/bin/protractor seed/static/seed/tests/protractor-tests/protractorConfigCoverage.js # echo "install coverall merge stuffs" # gem install coveralls-lcov -# pip install coveralls-merge # echo "run lcov to coveralls json" # coveralls-lcov -v -n protractorReports/lcov.info > coverage.protractor.json -# echo "merge and post coveralls" -# coveralls-merge coverage.protractor.json +# echo "upload to coveralls" diff --git a/docs/source/conf.py b/docs/source/conf.py index ac5d5c046f..57768e6b56 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -56,7 +56,9 @@ templates_path = ['_templates'] # Location of word list. -spelling_word_list_filename = '../../.cspell.json' +# convert the spelling list to a text file and save +open('../../.cspell.txt', 'w').write('\n'.join(json.load(open('../../.cspell.json'))['words'])) +spelling_word_list_filename = '../../.cspell.txt' # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: @@ -91,7 +93,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = 'en' # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: diff --git a/docs/source/docker.rst b/docs/source/docker.rst index 60db652e50..a0208c345b 100644 --- a/docs/source/docker.rst +++ b/docs/source/docker.rst @@ -110,7 +110,7 @@ Ubuntu server 18.04 or newer with a m5ad.xlarge (if using in Production instance Deploying with Docker -^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^ The preferred way to deploy with Docker is using docker swarm and docker stack. Look at the `deploy.sh script`_ for implementation details. diff --git a/docs/source/kubernetes_deployment.rst b/docs/source/kubernetes_deployment.rst index a67dc9ab44..3f70fdc154 100644 --- a/docs/source/kubernetes_deployment.rst +++ b/docs/source/kubernetes_deployment.rst @@ -59,14 +59,14 @@ Helm Helm organizes all of your Kubernetes deployment, service, and volume yml files into "charts" that can be deployed, managed, and published with simple commands. To install Helm: -* `Windows eksctl https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl-on-windows`_ +* `Windows eksctl `_ * Mac (with Homebrew) :code:`brew install helm` EKS Control (AWS Specific) ^^^^^^^^^^^^^^^^^^^^^^^^^^ EKSCtl is a command line tool to manage Elastic Kubernetes clusters on AWS. If not using AWS, then disregard this section. -* `Windows `_ +* `Windows eksctl config `_ * Mac (with Homebrew) :code:`brew install eksctl` To launch a cluster on using EKSCts, run the following command in the terminal (assuming adequate permissions for the user). Also make sure to replace items in the `<>` brackets. @@ -161,7 +161,7 @@ This chart contains the deployment specification for the Celery container to con value: # must match db-postgres-deployment.yaml and web-celery-deployment.yaml bsyncr-deployment.yaml -************************** +********************** This chart contains the deployment specification for the bsyncr analysis server. Request a NOAA token from `this website `_. .. code-block:: yaml @@ -239,7 +239,7 @@ The command below will restart the pods and re-pull the docker images. Other Resources --------------- -Common kubectl actions can be found `here `_ +Common kubectl actions can be found `on the kubernetes website `_ .. _AWS: https://docs.aws.amazon.com/eks/latest/userguide/create-cluster.html diff --git a/docs/source/migrations.rst b/docs/source/migrations.rst index cd321bd2ba..624a23c329 100644 --- a/docs/source/migrations.rst +++ b/docs/source/migrations.rst @@ -223,9 +223,7 @@ Max OSX Version 2.5.2 ------------- -- There are no manual migrations that are needed. The `./manage.py migrate` command may take awhile -to run since the migration requires the recalculation of all the normalized addresses to parse -bldg correct and to cast the result as a string and not a bytestring. +- There are no manual migrations that are needed. The `./manage.py migrate` command may take awhile to run since the migration requires the recalculation of all the normalized addresses to parse bldg correct and to cast the result as a string and not a bytestring. Version 2.5.1 ------------- diff --git a/docs/source/modules/seed.rst b/docs/source/modules/seed.rst index a8c3166a76..771c0324c2 100644 --- a/docs/source/modules/seed.rst +++ b/docs/source/modules/seed.rst @@ -80,14 +80,6 @@ Token Generator :undoc-members: :show-inheritance: -URLs ----- - -.. automodule:: seed.urls - :members: - :undoc-members: - :show-inheritance: - Utils ----- diff --git a/docs/source/modules/seed.utils.rst b/docs/source/modules/seed.utils.rst index 813f849f94..27fd9b6cf7 100644 --- a/docs/source/modules/seed.utils.rst +++ b/docs/source/modules/seed.utils.rst @@ -20,22 +20,6 @@ Buildings :undoc-members: :show-inheritance: -Constants ---------- - -.. automodule:: seed.utils.constants - :members: - :undoc-members: - :show-inheritance: - -Mappings --------- - -.. automodule:: seed.utils.mapping - :members: - :undoc-members: - :show-inheritance: - Organizations ------------- diff --git a/requirements/test.txt b/requirements/test.txt index 191964657e..7808659ee7 100644 --- a/requirements/test.txt +++ b/requirements/test.txt @@ -11,29 +11,28 @@ psutil==5.6.7 # python testing Faker==0.9.3 mock==2.0.0 -coveralls-merge==0.0.3 vcrpy==4.2.1 -pytest==7.2.0 -pytest-django==4.5.2 +pytest==7.4.4 +pytest-django==4.7.0 # Lock urllib3 to v1 until vcrpy supports it urllib3<2 # static code analysis -flake8==3.8.1 -pycodestyle==2.6.0 -pre-commit==2.19.0 +flake8==7.0.0 +pycodestyle==2.11.1 +pre-commit==3.6.0 # documentation and spelling -Sphinx==4.0.2 -sphinxcontrib-spelling==4.3.0 -sphinx_rtd_theme==0.4.3 -docutils==0.17.1 +Sphinx==7.2.6 +sphinxcontrib-spelling==8.0.0 +sphinx_rtd_theme==2.0.0 +docutils==0.20.1 # property-based testing -hypothesis==6.12.0 +hypothesis==6.94.0 # For running the server -uWSGI==2.0.22; sys_platform != "win32" +uWSGI==2.0.23; sys_platform != "win32" # static type checking -mypy==1.0.0 +mypy==1.8.0 diff --git a/tox.ini b/tox.ini index e8cf581650..25cc8bfbc4 100644 --- a/tox.ini +++ b/tox.ini @@ -44,6 +44,8 @@ changedir=docs deps= -r{toxinidir}/requirements/test.txt commands= + # After we fix doc build links/issues, then add the -W flag + ; make spelling SPHINXOPTS='-W --keep-going' make spelling sphinx-build -b html -d {envtmpdir}/doctrees {toxinidir}/docs/source {envtmpdir}/html whitelist_externals= @@ -76,7 +78,6 @@ passenv= TRAVIS_BUILD_NUMBER MAPQUEST_API_KEY whitelist_externals= - ; coveralls-merge cp npm