carsondavis / made_by_carson

Made by Carson

Site made to host various widgets and tools

License: MIT

Settings

Moved to settings.

Basic Commands

Setting Up Your Users

• To create a normal user account, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go.

• To create a superuser account, use this command:

  $ python manage.py createsuperuser
  

For convenience, you can keep your normal user logged in on Chrome and your superuser logged in on Firefox (or similar), so that you can see how the site behaves for both kinds of users.

Type checks

Running type checks with mypy:

$ mypy made_by_carson

Test coverage

To run the tests, check your test coverage, and generate an HTML coverage report:

$ coverage run -m pytest
$ coverage html
$ open htmlcov/index.html

Running tests with pytest

$ pytest

Live reloading and Sass CSS compilation

Moved to Live reloading and SASS compilation.

Celery

This app comes with Celery.

To run a celery worker:

cd made_by_carson
celery -A config.celery_app worker -l info

Please note: For Celery's import magic to work, it is important where the celery commands are run. If you are in the same folder with manage.py, you should be right.

To run periodic tasks, you'll need to start the celery beat scheduler service. You can start it as a standalone process:

cd made_by_carson
celery -A config.celery_app beat

or you can embed the beat service inside a worker with the -B option (not recommended for production use):

cd made_by_carson
celery -A config.celery_app worker -B -l info

Sentry

Sentry is an error logging aggregator service. You can sign up for a free account at https://sentry.io/signup/?code=cookiecutter or download and host it yourself. The system is set up with reasonable defaults, including 404 logging and integration with the WSGI application.

You must set the DSN url in production.

Deployment

If you are setting up the server for the first time, you'll need to follow a few steps:

Github Deploy Key

https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#generating-a-new-ssh-key

Follow these instructions to generate a new ssh key and add it to the ssh-agent. Then add the key to the github repository.

Install Docker on the Server

• https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-on-ubuntu-22-04
• https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-compose-on-ubuntu-22-04

Alias File

Not strictly necessary, but nice to have. add the following to your .bashrc file:

export COMPOSE_FILE='/home/ubuntu/made_by_carson/production.yml'
source ~/.aliases

create a .aliases file with the following commands:

alias dcd='docker compose -f /home/ubuntu/made_by_carson/production.yml down'
alias dmig='docker compose -f /home/ubuntu/made_by_carson/production.yml run --rm django python manage.py migrate'
alias dmshell='docker compose -f /home/ubuntu/made_by_carson/production.yml run --rm django python manage.py shell_plus'
alias dcup='docker compose -f /home/ubuntu/made_by_carson/production.yml up -d --build'

alias deploy='cd /home/ec2-user/made_by_carson;dcd;git pull origin master;dmig;dcup'

Docker

See detailed cookiecutter-django Docker documentation.

made_by_carson's Issues

Add CI/CD

• deploy keys
• add secrets
• add workflow triggered by master push

Add Google Analytics

Even if I add it to the base template, I still need to think about how I will handle external links to my own resources, such as the lockpicking sheet, etc.

AWS Resources Running

• ec2, ubuntu
• rds, latest postgres - turns out the cheapest is like $12/month...I'll just run it on the ec2
• route 53?
• static ip

goodreads exporter

Fix Sphinx Documentation

When running make -C docs livehtml, the following error occurs.

sphinx_args.filenames=[]
[sphinx-autobuild] > sphinx-build -b html -c . . ./_build/html
Running Sphinx v7.2.6

Configuration error:
There is a programmable error in your configuration file:

Traceback (most recent call last):
  File "/Users/cdavis/github/made_by_carson/venv/lib/python3.11/site-packages/sphinx/config.py", line 358, in eval_config_file
    exec(code, namespace)  # NoQA: S102
    ^^^^^^^^^^^^^^^^^^^^^
  File "/Users/cdavis/github/made_by_carson/docs/conf.py", line 27, in <module>
    django.setup()
  File "/Users/cdavis/github/made_by_carson/venv/lib/python3.11/site-packages/django/__init__.py", line 19, in setup
    configure_logging(settings.LOGGING_CONFIG, settings.LOGGING)
                      ^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/cdavis/github/made_by_carson/venv/lib/python3.11/site-packages/django/conf/__init__.py", line 102, in __getattr__
    self._setup(name)
  File "/Users/cdavis/github/made_by_carson/venv/lib/python3.11/site-packages/django/conf/__init__.py", line 89, in _setup
    self._wrapped = Settings(settings_module)
                    ^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/cdavis/github/made_by_carson/venv/lib/python3.11/site-packages/django/conf/__init__.py", line 217, in __init__
    mod = importlib.import_module(self.SETTINGS_MODULE)
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/Caskroom/miniconda/base/envs/py311/lib/python3.11/importlib/__init__.py", line 126, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "<frozen importlib._bootstrap>", line 1206, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1178, in _find_and_load
  File "<frozen importlib._bootstrap>", line 1128, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 241, in _call_with_frames_removed
  File "<frozen importlib._bootstrap>", line 1206, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1178, in _find_and_load
  File "<frozen importlib._bootstrap>", line 1128, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 241, in _call_with_frames_removed
  File "<frozen importlib._bootstrap>", line 1206, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1178, in _find_and_load
  File "<frozen importlib._bootstrap>", line 1142, in _find_and_load_unlocked
ModuleNotFoundError: No module named 'config'

Sphinx exited with exit code: 2
The server will continue serving the build folder, but the contents being served are no longer in sync with the documentation sources. Please fix the cause of the error above or press Ctrl+C to stop the server.

Get Basic Site Running

• cookie cutter django
• compose managed dockers
• nginx in compose? check sde-indexing-helper repo
• pre commit hooks for flake8 and black, with 120 char limit