Desenvolvedores e administradores de instâncias Bookwyrm podem usar o script bw-dev para tarefas cotidianas. Isso pode tornar seus comandos mais curtos, mais fáceis de lembrar e mais difíceis de serem confundidos.
Se tiver uma instalado uma instância BookWyrm em produção ou em desenvolvimento, você pode executar o script pela linha de comando com ./bw-dev seguido com um subcomando para executar.
Abre uma sessão bash interativa dentro do container web do Docker.
Equivalente ao docker-compose build.
Abre um shell interativo do banco de dados Postgres. Espero que você saiba o que está fazendo.
Executa um comando arbitrário (representado acima pelo args) no container web.
Equivalent to docker-compose run --rm web.
Executa um comando arbitrário no container web (representado acima por args) com as portas expostas. Isso é útil para quando você quer executar testes pdb porque o runweb não irá expor o promp pdb.
Equivalente ao docker-compose run --rm --service-ports web.
Abre um shell interativo Django dentro do container web do Docker. Você pode usar isso se quiser executar comandos do shell do Django diretamente.
Inicia ou reinicia containers do Docker, incluindo opcionalmente quaisquer argumentos (representados acima por args). Equivalente ao docker-compose up --build [args]
Inicializa um banco de dados.
Este comando não está disponível no branch produção.
Executa o comando makemigrations do Django dentro do seu container Docker. Se você alterou a estrutura do banco de dados em um branch de desenvolvimento, você precisará executar este comando para que suas alterações tenham efeito. Facultativamente, você pode especificar alguma migração para executar, p. ex. ./bw-dev makemigrations bookwyrm 0108
Executa o comando migrate do Django dentro de seu container Docker. Você sempre irá precisar executá-lo após o makemigrations.
Este comando não está disponível no branch produção.
Reinicia o banco de dados. Este comando vai excluir todo o banco de dados da BookWyrm, criar outro banco de dados e executar todas as migrações. Você deve deletar todos os arquivos de migração recentes que não quer rodar antes de executar resetdb.
Compiles all BookWyrm themes, which are *.scss files listed in bookwyrm/static/css/themes.
Migrate static assets to either a Docker container or to an S3-compatible "bucket", depending on the context.
Generate preview images for site, users, and books. This can take a while if you have a large database. See Optional Features: Generating preview images
Remove generated preview images for remote users. See Optional Features: Removing preview images for remote users
Generates thumbnail images for book covers.
Re-populates Redis streams (user feeds). You will not usually need to run this unless there is an error that wipes out your user feeds for some reason. You can specify which stream using the --stream argument.
Re-populates Redis cache of lists. You will not usually need to run this unless there is an error that wipes out your users' lists for some reason.
Populate suggested users for all users. You may want to run this manually to refresh suggestions.
Restarts the celery_worker Docker container.
When there are changes to the production branch, you can update your instance without downtime.
This command git pulls the latest production branch updates, builds docker images if necessary, runs Django migrations, updates static files, and restarts all Docker containers.
Gets the secret admin code used to register the inital admin user on a new BookWyrm instance.
By default, BookWyrm uses local storage for static assets (favicon, default avatar, etc.), and media (user avatars, book covers, etc.), but you can use an external storage service to serve these files. BookWyrm uses django-storages to handle external storage, such as S3-compatible services, Apache Libcloud or SFTP.
See External Storage for more information.
Migrate all uploaded media from an existing BookWyrm installation to an S3-compatible "bucket". Use for initial upload to an empty bucket.
Sync new or changed uploaded media from an existing BookWyrm installation to an S3-compatible "bucket". Use to ensure all local files are uploaded to an existing bucket.
Copy a CORS rules JSON file to your S3 bucket, where filename is the name of your JSON file (e.g. ./bw-dev set_cors_to_s3 cors.json)
These commands are not available on the production branch.
BookWyrm uses the Black code formatter to keep the Python codebase consistent styled. Run black before committing your changes so the pylint task does not fail for your pull request and make you sad.
BookWyrm uses Prettier to keep the JavaScript codebase consistently styled. Run prettier before committing changes to scripts to automatically format your code.
BookWyrm uses Stylelint to keep the CSS files consistently styled. Run stylelintprettier before committing changes to scripts to automatically format your code.
This command runs all code formatters (black, prettier, and stylelint) in one go.
Remove all stopped Docker containers.
Equivalent to:
docker-compose stop
docker-compose rm -f
Creates message files for all translation strings. After you have run makemessages you need to run compilemessages to compile the translations. See Django's makemessages.
Compiles translation files. See Django's compilemessages.
Run tests with pytest.
Deactivates two factor authentication for a given user.
Confirms a users email, sets the user to active.