Update readme #136
Update readme #136
Conversation
- Removes sections that are irrelevant in E-kirjasto. - Includes changes to how the project is currently built using Docker. - Changes related to how Python 3.11 with venv is used to run tests (or the app locally). pyenv was a headache.
natlibfi-kaisa
requested review from
natlibfi-ptalosel,
NatLibFi-JoonaKupe and
natlibfi-burger
There was a problem hiding this comment.
I tried to do the setup
- I finished 1 Set up and run the application with Docker Compose.
- In section 2 Python and dependencies to run tests (and the application locally) I encountered a problem: one necessary dependency (libxmlsec1) could not be installed with these README instructions.
- I could not proceed to section 3 Testing because of the error in dependency installation
| ```shell | ||
| python3 --version | ||
| ```sh | ||
| docker compose -f docker-compose-dev.yml up --build -d |
There was a problem hiding this comment.
I had to comment out data-api section in docker-compose-dev.yml, otherwise an error would appear: Error response from daemon: no matching manifest for linux/arm64/v8 in the manifest list entries: no match for platform in manifest: not found
|
|
||
| ```sh | ||
| brew install pkg-config libffi | ||
| brew install tvuotila/libxmlsec1/[email protected] |
There was a problem hiding this comment.
Could not be installed. Homebrew displayed this error when trying to install Error: [email protected] has been disabled because it is not supported upstream! It was disabled on 2024-10-24.
| brew install pkg-config libffi | ||
| brew install libxmlsec1 | ||
| brew install libjpeg | ||
| brew install [email protected] |
There was a problem hiding this comment.
Could not be installed via Homebrew. Instead, I installed first pipx via Homebrew, then pipx install poetry==1.8.3. I also had to add Poetry directory to PATH environment.
Description
Updated README follows the current way the project is built.
Motivation and Context
The older version used
pyenvto handle differentpythonversions but using it had many problems. We use 3.11 sosimply creating a good old-fastioned
venvwith that version is enough and simplifies everything.Some versions of dependencies to use, namely
poetryandlibxmlsec1are now specified.Docker is the recommended way to run the application so it's been put to the top.
A lot of restructuring and removing useless sections not used in E-kirjasto was done to make the file more easier to read.
How Has This Been Tested?
I've followed the steps described in the file for some time now. The reviewers should follow the steps to confirm they are also able to run the application with Docker AND run the
apiandcoretests.