Skip to content

Commit

Permalink
more removal & dev docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
Josh committed Jan 6, 2025
1 parent 1672346 commit ac7b502
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 28 deletions.
3 changes: 0 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,6 @@ migrate_down_sqlite:
clear_sqlite:
sqlite3 ~/.sematic/db.sqlite3 < sematic/db/scripts/clear_all.sql

install-dev-deps:
pip3 install -r requirements/ci-requirements.txt

pre-commit:
uvx ruff format --check
uvx ruff check --fix sematic
Expand Down
11 changes: 0 additions & 11 deletions docker/Dockerfile.ci

This file was deleted.

2 changes: 0 additions & 2 deletions docker/Dockerfile.server
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
# Dockerfile for the API server
# Ideally we would do this via Bazel instead but the py3_image rules
# are currently broken for M1 Macs

# see https://stackoverflow.com/questions/65612411/forcing-docker-to-use-linux-amd64-platform-by-default-on-macos/69636473#69636473
# for why --platform
Expand Down
23 changes: 11 additions & 12 deletions docs/developers/manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,31 @@

## Getting started

## Build System

Install Bazel:
- [MacOS](https://bazel.build/install/os-x#install-on-mac-os-x-homebrew)
- [Ubuntu](https://bazel.build/install/ubuntu#install-on-ubuntu)
- [RHEL](https://bazel.build/install/redhat)

## Dev Tools

```shell
$ make install-dev-deps
$ make py-prep
```

## Add a third-party pip dependency

Add your dependency to `requirements/requirements.in`. Avoid pinning a fixed version unless necessary.
Add your dependency to `pyproject.toml`. Avoid pinning a fixed version unless necessary.

Then run (only supported on Linux):
```shell
$ make refresh-dependencies
```

## Activate virtual environment

```shell
$ source .venv/bin/activate
```

## Starting the API server

```shell
$ bazel run //sematic/api:server
$ python -m sematic.api.server
```

## Starting the UI Dashboard
Expand Down Expand Up @@ -111,7 +110,7 @@ If, at a later stage, we need to remove the __MyNewPlugin__ component for any re
This is if you want to package a dev Sematic version for installation somewhere else:

```shell
$ make install-dev-deps # if not done before
$ make py-prep # if not done before
$ make ui
$ make wheel
```
```

0 comments on commit ac7b502

Please sign in to comment.