Science Score: 44.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
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (16.7%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: mindsresearch
  • License: agpl-3.0
  • Language: TeX
  • Default Branch: main
  • Size: 49.6 MB
Statistics
  • Stars: 4
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 2
Created about 2 years ago · Last pushed about 2 years ago
Metadata Files
Readme Contributing License Code of conduct Citation Codeowners Security

README.md

Between Bytes

[!WARNING] This repo is currently undergoing a major renaming from "SelfScape Insight" to "Between Bytes". Please forgive any such discrepancies in the docs!

Overview

Between Bytes is a Python project developed as part of the WWU Data Science Senior Project. It's designed to provide insights from Facebook data, making it easier for users to visualize and understand their social media interactions.

Features

  • CLI Interface: Easy-to-use command-line interface.
  • GUI Interface: Even easier to use graphical wizard-style launcher.
  • Data Visualization: Generate comprehensive visualizations of Facebook data.
  • COMING SOON Customizable Outputs: Tailor the outputs based on user-specific needs.

Installation

From Binary

COMING SOON

An .exe version of the program is coming soon to make running it even easier!

Download the latest version as a whl file from the Releases section on the right sidebar of this repository.

bash pip install path/to/between_bytes-<version>-py3-none-any.whl

Compiling from Source

This project uses flit for packaging and distribution and sphinx for generating documentation.

Set Up

Ensure you are in the project's root directory (./between_bytes).

Building & Installing the Wheel

Install flit if it is not already installed: bash pip install flit Build and install the project: bash flit install

Usage

Run the CLI version of Between Bytes: bash btb-cli -h for command-line help

For the GUI version, run: bash btb-gui

Documentation

Building Reference Docs

[!CAUTION] These instructions are untested and may require adjustments.

Follow the setup and build instructions above, then run: bash pip install dist/<wheel_name>.whl[doc] cd docs make clean html The generated documentation will be available in docs/_build/html.

Contributing

Contributions are welcome! Please see our contributing guidelines for more information on how to report bugs, submit patches, and propose new features.

License

Between Bytes is licensed under [GNU AGPL-3.0]. See the LICENSE file for more details.

Contact

For more support or to provide feedback, please refer to the SECURITY guidelines and the CODE OF CONDUCT.

Owner

  • Name: Mobility, Innovation, and NeuroDiverse Solutions Research
  • Login: mindsresearch
  • Kind: organization
  • Location: United States of America

Citation (CITATION.cff)

cff-version: 1.2.0
title: Selfscape Insight
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Noah
    family-names: Duggan Erickson
    email: duggann@wwu.edu
    affiliation: Western Washington University
    orcid: 'https://orcid.org/0009-0004-1135-2025'
  - given-names: Liam
    family-names: Gore
    email: gorel2@wwu.edu
    affiliation: Western Washington University
  - given-names: Peter
    family-names: Hafner
    email: hafnerp2@wwu.edu
    affiliation: Western Washington University
  - given-names: Carter
    family-names: Jacobs
    email: jacobs81@wwu.edu
    affiliation: Western Washington University
  - given-names: Trevor
    family-names: Le
    email: let38@wwu.edu
    affiliation: Western Washington University
repository-code: 'https://github.com/mindsresearch/selfscape-insight'
license: AGPL-3.0

GitHub Events

Total
Last Year

Dependencies

.github/workflows/pylint.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v5 composite
pyproject.toml pypi
  • beautifulsoup4 *
  • flatsplode *
  • folium *
  • geopandas *
  • matplotlib *
  • maxminddb *
  • nbformat *
  • pandas *
  • pillow *
  • plotly *
  • pyarrow *
  • requests *
  • seaborn *
  • spacy *
  • spacytextblob *
  • timeout-decorator *
  • tqdm *
  • wordcloud *
requirements.txt pypi
  • beautifulsoup4 *
  • flatsplode *
  • folium *
  • geopandas *
  • matplotlib *
  • maxminddb *
  • nbformat *
  • pandas *
  • pillow *
  • plotly *
  • pyarrow *
  • requests *
  • seaborn *
  • spacy *
  • spacytextblob *
  • timeout-decorator *
  • tqdm *
  • wordcloud *
.github/workflows/documentation.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • peaceiris/actions-gh-pages v3 composite