Data

Tools

Indexes

Applications

Experiments

Open Source Science

photo-frame

A simple photo frame application with web interface

https://github.com/thompson318/photo-frame

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 1 committers (100.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.4%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

A simple photo frame application with web interface

Basic Info
  • Host: GitHub
  • Owner: thompson318
  • License: gpl-3.0
  • Language: Python
  • Default Branch: main
  • Size: 73.2 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 1 year ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation

README.md

photoframe

pre-commit Tests status Linting status Documentation status License

A photo frame

This project is developed in collaboration with the Centre for Advanced Research Computing, University College London.

About

Project Team

Stephen Thompson (stephen.thompson@ucl.ac.uk)

Research Software Engineering Contact

Centre for Advanced Research Computing, University College London (arc.collaborations@ucl.ac.uk)

Built With

Getting Started

Prerequisites

photoframe requires Python 3.10–3.12.

Installation

We recommend installing in a project specific virtual environment created using a environment management tool such as Conda. To install the latest development version of photoframe using pip in the currently active environment run

sh pip install git+https://github.com/thompson318/photoframe.git

Alternatively create a local clone of the repository with

sh git clone https://github.com/thompson318/photoframe.git

and then install in editable mode by running

sh pip install -e .

Running Locally

How to run the application on your local system.

Running Tests

Tests can be run across all compatible Python versions in isolated environments using tox by running

sh tox

To run tests manually in a Python environment with pytest installed run

sh pytest tests

again from the root of the repository.

Building Documentation

The MkDocs HTML documentation can be built locally by running

sh tox -e docs

from the root of the repository. The built documentation will be written to site.

Alternatively to build and preview the documentation locally, in a Python environment with the optional docs dependencies installed, run

sh mkdocs serve

Roadmap

  • [x] Initial Research
  • [ ] Minimum viable product <-- You are Here
  • [ ] Alpha Release
  • [ ] Feature-Complete Release

Acknowledgements

This work was funded by none.

Owner

  • Name: Stephen Thompson
  • Login: thompson318
  • Kind: user
  • Location: London, United Kingdom
  • Company: Advanced Research Computing, UCL

Research Software Engineer

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
type: software
authors:
  - family-names: "Thompson"
    given-names: "Stephen"
    email: "stephen.thompson@ucl.ac.uk"
repository-code: "https://github.com/thompson318/photoframe"
title: "photoframe: A photo frame"
license: "GPL-3.0"

GitHub Events

Total
  • Push event: 26
  • Create event: 1
Last Year
  • Push event: 26
  • Create event: 1

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 66
  • Total Committers: 1
  • Avg Commits per committer: 66.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 66
  • Committers: 1
  • Avg Commits per committer: 66.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Stephen Thompson s****n@u****k 66
Committer Domains (Top 20 + Academic)
ucl.ac.uk: 1

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Dependencies

.github/workflows/docs.yml actions
  • actions/cache 0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 composite
  • actions/checkout 692973e3d937129bcbf40652eb9f2f61becf3332 composite
  • actions/setup-python f677139bbe7f9c59b41e40162b753c062f5d49a3 composite
  • peaceiris/actions-gh-pages 4f9cc6602d3f66b9c108549d475ec49e8ef4d45e composite
.github/workflows/linting.yml actions
  • actions/cache 0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 composite
  • actions/checkout 692973e3d937129bcbf40652eb9f2f61becf3332 composite
  • actions/setup-python f677139bbe7f9c59b41e40162b753c062f5d49a3 composite
.github/workflows/tests.yml actions
  • actions/cache 0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 composite
  • actions/checkout 692973e3d937129bcbf40652eb9f2f61becf3332 composite
  • actions/setup-python f677139bbe7f9c59b41e40162b753c062f5d49a3 composite
pyproject.toml pypi
  • Flask *
  • opencv-python-headless *