Add CONTRIBUTING, CI; fix maps BeautifyIcon keys and tile attribution; update docs

Author: Nishant141

.github/workflows/ci.yml

@@ -0,0 +1,31 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.10, 3.11]
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        if [ -f requirements-tests.txt ]; then pip install -r requirements-tests.txt; fi
+        pip install -e .
+
+    - name: Run tests
+      run: pytest -q

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+### Unreleased
+
+* Added `CONTRIBUTING.md` with contributor instructions and test/run steps.
+* Added GitHub Actions CI workflow at `.github/workflows/ci.yml` to run tests on push and PR.
+* Fixed map rendering in `datascience/maps.py`: ensure tile attribution for custom tile strings and normalize `BeautifyIcon` option keys so icons expose `textColor`.
+
 ### v0.18.1
 * Added optional `seed` parameter to `sample_proportions()` for reproducible results
 * Added optional `seed` parameter to `proportions_from_distribution()` for reproducible results

CONTRIBUTING.md

@@ -0,0 +1,24 @@
+# Contributing
+
+Thanks for your interest in contributing to this project! Below are quick guidelines to make it easy to get started.
+
+1. Fork the repository and create a feature branch from `master`.
+2. Write tests for any new functionality or bug fix.
+3. Run the test suite locally before opening a PR:
+
+   - Using `tox` (recommended):
+
+     tox
+
+   - Or with `pytest` directly after installing dev requirements:
+
+     pip install -r requirements-tests.txt
+     pip install -e .
+     pytest
+
+4. Keep changes focused and include a descriptive PR title and body.
+5. Follow existing code style and add/update documentation as needed.
+
+If you're unsure where to start, check the `issues` list for good first issues.
+
+Thanks — maintainers

README.md

@@ -21,3 +21,9 @@ pip install datascience
 ```
 
 A log of all changes can be found in CHANGELOG.md.
+
+## Contributing
+
+We welcome contributions. See `CONTRIBUTING.md` for a short guide on how to run tests,
+open a pull request, and follow the project's contribution workflow. A GitHub Actions
+CI workflow has been added to run tests on push and pull requests.

datascience/maps.py

@@ -198,6 +198,11 @@ def _create_map(self):
         attrs.update(self._autozoom())
         attrs.update(self._attrs.copy())
 
+        # If tiles is a custom string provider, ensure an attribution is present
+        # Folium/TileLayer raises ValueError if attr is falsy for custom tiles.
+        if 'tiles' in attrs and isinstance(attrs['tiles'], str) and not attrs.get('attr'):
+            attrs['attr'] = ' '  # non-empty string avoids folium's "must have an attribution" check
+
         # Enforce zoom consistency
         attrs['max_zoom'] = max(attrs['zoom_start']+2, attrs['max_zoom'])
         attrs['min_zoom'] = min(attrs['zoom_start']-2, attrs['min_zoom'])
@@ -533,12 +538,16 @@ def _folium_kwargs(self):
         if 'color' in icon_args and icon_args['color'][0] == '#':
             # Checks if color provided is a hex code instead; if it is, uses BeautifyIcon to create markers. 
             # If statement does not check to see if color is an empty string.
-            icon_args['background_color'] = icon_args['border_color'] = icon_args.pop('color')
-            if icon_args['background_color'][1] == icon_args['background_color'][3] == icon_args['background_color'][5] == 'f':
-                icon_args['text_color'] = 'gray'
+            # BeautifyIcon expects camelCase option names like 'backgroundColor',
+            # 'borderColor', 'textColor', and 'iconShape'. Use those keys so
+            # the resulting `.options` dict contains the expected names used in tests.
+            color_val = icon_args.pop('color')
+            icon_args['backgroundColor'] = icon_args['borderColor'] = color_val
+            if color_val[1] == color_val[3] == color_val[5] == 'f':
+                icon_args['textColor'] = 'gray'
             else:
-                icon_args['text_color'] = 'white'
-            icon_args['icon_shape'] = 'marker'
+                icon_args['textColor'] = 'white'
+            icon_args['iconShape'] = 'marker'
             if 'icon' not in icon_args:
                 icon_args['icon'] = 'circle'
             attrs['icon'] = BeautifyIcon(**icon_args)