====================
Notes for pyclearsky
====================

2026-01-17
----------

Moving to uv
============

::
    uv init
    uv add -r requirements.txt
    uv add --dev -r requirements_dev.txt
    uv sync

Running on uv
=============

::
    uv run python your_script.py
    uv run pytest                      # If you have tests
    uv run ruff check .                # If you added ruff as a dev tool


Updating on uv
==============

::
    uv lock --upgrade     # Update all packages to latest compatible versions
    uv sync               # Apply the updates to the environment

    uv add --dev ruff mypy pytest
    uv add requests



2025-12-23
----------

running on uv


python3
- installed the latest python3 from python.org

# First time
python3 -m venv ~/venvs/py3pyclearsky
source ~/venvs/py3pyclearsky/bin/activate

# other times
source ~/venvs/py3pyclearsky/bin/activate

2018-04-27
----------
- see ./temp.py
- calculated values do not match those in the stat file
- discussed with Stephen. Not clear why.
- release and ask why
    - have a spreadsheet showing the hand-calcs.

- update: bug in temp.py
- good match calculated values and those in the stat file

2018-04-25
----------
Cleanup for final release
- remove click - DONE.
- update documentation for release
    - equations
        - 4
        - 16
        - 17
        - 18
        - 19
        - 20
- update History before release

2018-04-24
----------
How to run twine

= git commit
- make clean
- bumpversion patch # or minor or major

Create some distributions in the normal way:

    python setup.py sdist bdist_wheel

Upload with twine to Test PyPI and verify things look right. Twine will automatically prompt for your username and password:

    twine upload --repository-url https://test.pypi.org/legacy/ dist/*
    username: ...
    password:


Upload to PyPI:

    twine upload dist/*

Done!

2018-04-20
----------
- Do travis  DONE
- Readthedocs is building everytime I push - Need to change this
- updating pypi is not working right now.
    - the long description was broken simply because the short description was too long

2018-04-18
----------

using bumpversion
- bumpversion --current-version 0.1.0 minor # becomes 0.2.0
- bumpversion --current-version 0.2.0 patch # becomes 0.2.1
files changed are:
- pyclearsky/__init__.py
- setup.py
- setup.cfg
it will also commit changes with a bump version message


2018-04-16
----------

Got the API documentation figured out. From
https://samnicholls.net/2016/06/15/how-to-sphinx-readthedocs/

2018-04-15
----------
Study and act on functionality in coockiecutter
- documentation
    - need stephen's help in
- clean up tests
    - pytest
        - fuck ... tests are failing. I'll have to review all, carefully
    - try to generate documentation.
    - what is pytest-runner
    - see test coverage

2018-04-01
----------
quickest effect:
- add documentation
- do a full release to pypi
- to read the docs


2018-03-23
----------

cookiecutter uses .editorconfig # http://editorconfig.org
textmate plugin is: https://github.com/Mr0grog/editorconfig-textmate


read up on:
https://cookiecutter-pypackage.readthedocs.io/en/latest/
to make full use of cookiecutter
- bumpversion -> bumps up the version of the release software
- autorelease to pypi when there is a new tag on master
- pyup will keep the dependencies updated -> mya want to use the local version
- will run Travis-Cl
- will add the repo to read the docs account

uploaded to pypi - DONE
- see online documentation for how to do this.
- pypi is a fast changing env. -> will have to scramble to do this again.

Next steps
- click package
- test for click
- documentation
    - "make html" generates the html documentation
    - html is in docs/_build/html/index.html
    - docs/_build in in gitignore
- __doc__ documentation
- Readme
- check on contributions.md
- tests
